Skip to main content
POST
/
v1
/
sync-configs
/
{config_id}
/
sync
Trigger sync
curl --request POST \
  --url https://api.cuadra.ai/v1/sync-configs/{config_id}/sync \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "syncConfigId": "<string>",
  "status": "<string>",
  "triggeredBy": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "itemsTotal": 123,
  "itemsCompleted": 0,
  "itemsFailed": 0,
  "itemsSkipped": 0,
  "creditsConsumed": 0,
  "bytesProcessed": 0,
  "errorMessage": "<string>",
  "progress": 123
}

Authorizations

​
Authorization
string
header
required

JWT token from Stytch B2B authentication (magic link, SSO, or M2M)

Headers

​
Idempotency-Key
string | null

Path Parameters

​
config_id
string
required

Sync config ID

Response

Successful Response

Sync job execution.

​
id
string
required
​
syncConfigId
string
required
​
status
string
required
​
triggeredBy
string
required
​
createdAt
string<date-time>
required
​
startedAt
string<date-time> | null
​
completedAt
string<date-time> | null
​
itemsTotal
integer | null
​
itemsCompleted
integer
default:0
​
itemsFailed
integer
default:0
​
itemsSkipped
integer
default:0
​
creditsConsumed
integer
default:0
​
bytesProcessed
integer
default:0
​
errorMessage
string | null
​
progress
number | null