Skip to main content
POST
Run an on-demand CRM object sync

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

destination
enum<string>
required
Available options:
salesforce,
hubspot,
braze,
iterable,
customer_io,
klaviyo

Body

application/json

On-demand object-sync request. The destination, object type and field map come from the URL param + stored config, never the body.

segment_id
string
required
Required string length: 1 - 200
profiles
object[]
required

Source profiles — each an arbitrary bag of traits keyed by source path. Profiles missing the upsert key are skipped, never blind-inserted.

Required array length: 1 - 5000 elements

Response

The recorded sync run

data
object

A recorded CRM object-sync run (counts only — never the profile records / PII).

meta
object