Run a sync now
Syncs
Run a sync now
Queues a run and returns it with status queued. Poll GET /v2/sync_runs/{id} or subscribe to sync_run.* events. 409 sync_already_running while a run is queued or running.
POST
Run a sync now
Authorizations
Authorization: Bearer rbk_live_...
The API release your integration is built against, e.g. 2026-10-01.wattle. Required on every request.
Path Parameters
The id of the object.
Example:
"sync_8Pq2Rs4tUv6wXy8zAb1cDe"
Response
object | null
The queued run
include[]=latest_run
Example:
"run_4Kt7Lm2nPq9rSv1wXy3zAb"
Available options:
sync_run Available options:
queued, running, succeeded, failed, cancelled Available options:
schedule, api, dashboard, webhook, resync Example:
"2026-08-21T09:30:00.000Z"
Example:
"2026-08-21T09:30:00.000Z"
Example:
"2026-08-21T09:30:00.000Z"