Skip to main content
POST
Trigger a sync

Authorizations

Authorization
string
header
required

A scoped Integration key, prefixed cint_. Send as Authorization: Bearer cint_... on every request. Server-side only. Legacy personal cmem_... keys remain accepted during migration; team/org-scoped cmem_... keys are not valid on this API.

Body

application/json
endUserId
string
required

Your stable internal user ID. No colon allowed.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9@._-]{1,128}$
Example:

"u_123"

type
string
required

Data-source type id. Any source-capable type in the connector catalog (~200 sources — Gmail, Slack, HubSpot, Notion, Linear, Salesforce, warehouses, …); enumerate them via GET /api/v1/connectors/catalog.

Pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
Example:

"hubspot"

collections
string[]

Rescope which collections this source syncs, from this sync on. Omit to keep the current scope (default: everything). Ids come from GET /api/v1/connectors/{type}/collections; for credentials connectors (Twenty CRM) these are object ids, and one the instance does not expose fails with 400 unknown_twenty_objects.

Required array length: 1 - 100 elements

Response

Sync started in the background.

success
boolean
required
started
boolean
required

A background sync run began on this request.