POST
/
syncs
/
{sync_id}
/
trigger
Trigger a sync run
curl --request POST \
  --url https://app.getcensus.com/api/v1/syncs/{sync_id}/trigger \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "sync_run_id": 1234567890
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

​
sync_id
integer
required

ID of the sync

Query Parameters

​
force_full_sync
boolean
default:false

Determines if the sync should be run as a Full Sync. Note that some sync configurations such as Append do not support full syncs.

Response

200 - application/json

Sync triggered successfully.

​
status
enum<string>
required

The outcome of the fetch request

Available options:
success
Example:

"success"

​
data
object
required