Sync CRM Now

POST

crm

sync

Sync this workspace's customers to its connected CRM now

curl --request POST \
  --url https://billing.example.com/v1/crm/sync \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/crm/sync', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/crm/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/crm/sync"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/crm/sync")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "contacts_synced": 123,
    "contacts_remaining": 123
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Runs the CRM sweep for the calling workspace synchronously and reports how many customers were upserted as CRM contacts. It exists to verify a connection just stored with Connect an Integration (category: crm, provider: hubspot) without waiting for the daily sweep — so one call is capped at 25 contacts. Anything left over is reported in contacts_remaining and finished by the daily sweep. When the provider rejects every contact (bad token, missing scopes) — or rejects the custom property bootstrap that runs first — the call fails with a 424 carrying the provider’s own error. The operation description shown above says 502 for that case; the API deliberately answers 424 instead — the edge proxy in front of the hosted API replaces origin 502 responses with its own HTML error page, which would swallow the provider’s message — and the spec’s response list already declares 424. When at least one contact was upserted, the call returns 200 and any individual contacts the provider rejected are logged server-side only; they are counted in neither contacts_synced nor contacts_remaining, and the daily sweep retries them.

Example Request

curl -X POST "https://api.recurso.dev/v1/crm/sync" \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "data": {
    "contacts_synced": 25,
    "contacts_remaining": 112
  }
}

Fields

Field	Type	Description
`contacts_synced`	integer	Contacts upserted in the CRM by this call (at most 25)
`contacts_remaining`	integer	Eligible contacts left unattempted once the 25-contact cap was reached; the daily sweep finishes them. Contacts the provider rejected are not included

Errors

Status	Code	When	Fix
`400`	`validation_failed`	No CRM is connected for this workspace	Connect HubSpot with Connect an Integration first
`401`	`unauthorized`	Missing or invalid API key / session	Send `Authorization: Bearer $API_KEY`
`424`	`internal_error`	No contact could be upserted: the provider rejected them, the property bootstrap failed, or the customer list could not be read; the message carries the underlying error (`CRM sync failed: ...`)	Fix the token or scopes in HubSpot and reconnect
`503`	`internal_error`	CRM sync is not enabled on this server (the CRM worker is not running)	Self-hosted: enable the CRM sync worker

Errors use the standard envelope — see Errors.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Response

Sweep completed.

data

object

Show child attributes

Sync this workspace's customers to its connected CRM now

curl --request POST \
  --url https://billing.example.com/v1/crm/sync \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/crm/sync', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/crm/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/crm/sync"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/crm/sync")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "contacts_synced": 123,
    "contacts_remaining": 123
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Example Request

Response

Fields

Errors

Authorizations

Response

​Example Request

​Response

​Fields

​Errors

Authorizations

Response

Example Request

Response

Fields

Errors