Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Provide your API key in the x-api-key header.

Body

application/json
crm
enum<string>

Target CRM. Required only when more than one connected CRM has mapping settings.

Available options:
hubspot,
salesforce,
pipedrive,
sellsy
settings_type
string

Which team-level settings record to sync with when several exist for the CRM (settings are stored per use-case: api_sync, contact_sourcing, job_changes, ...). When omitted, resolution prefers the dedicated api_sync record (configured in the "API Sync" tab of the CRM integration), then falls back to contact_sourcing, then the only existing record.

contacts
object[]

Contacts to create/update (company fields may be embedded on each contact).

Maximum array length: 100
companies
object[]

Companies to create/update, without contacts.

Maximum array length: 100
webhook_url
string

Called once with the run summary when every record has been processed.

webhook_id
string

Deliver every record to this platform webhook (id from GET /webhooks) instead of a CRM. No CRM connection or mapping is required. Mutually exclusive with crm / settings_type; distinct from webhook_url (the completion callback).

idempotency_key
string

Reuse the same key to make client retries return the existing run instead of double-writing.

trigger_by
string

Response

CRM sync run accepted

id
string

Run id, used to poll the status endpoint

status
string
Example:

"processing"

createdAt
string<date-time>
records_received
integer
crm
string
Example:

"hubspot"