Create sync job
POST/integrations/sync-jobs
Plans and optionally executes a data sync job for a connector. The sync engine validates the plan, creates the job record, and — if execute_now is true — immediately starts the sync run. Use this for on-demand syncs or to schedule a planned batch transfer.
Request
Request body
Content type application/json (required).
| Field | Type | Required | Description |
|---|---|---|---|
connector_id | integer | Yes | ID of the connector account to sync. |
direction | string | No | Direction of the data transfer for this job. One of: |
planned_records | integer | No | Estimated number of records to sync. Used for progress reporting. Default: |
execute_now | boolean | No | If true, executes the sync job immediately after planning rather than leaving it in 'planned' status for a scheduled runner. Default: |
scope_json | string, nullable | No | JSON object constraining the sync scope (e.g. date range, entity types). |
Example
{
"connector_id": 4,
"direction": "push",
"planned_records": 2500,
"execute_now": true,
"scope_json": "{\"entity\":\"contacts\",\"updated_since\":\"2026-04-01T00:00:00Z\"}"
}Responses
302 Redirect to sync jobs list after the job is queued or executed
422 Validation error — connector_id is required and must exist
Example request
curl -X POST "https://{tenant}.faciotech.net/api/v1/integrations/sync-jobs" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"connector_id": 4, "direction": "push", "planned_records": 2500, "execute_now": true, "scope_json": "{\"entity\":\"contacts\",\"updated_since\":\"2026-04-01T00:00:00Z\"}"}'