Trigger a sync run

Triggers the sync with the specified ID to start a new sync run.

Request schema

sync_id

integerrequired

ID of the sync

force_full_sync

boolean

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

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

POST

https://app.getcensus.com/api/v1/syncs/{sync_id}/trigger

POST /api/v1/syncs/{sync_id}/trigger?force_full_sync=SOME_BOOLEAN_VALUE HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

200

Sync triggered successfully.

status

stringrequired

The outcome of the fetch request

enum:

"success"

data

objectrequired

sync_run_id

integer

example:

1234567890

{
  "status": "success",
  "data": {
    "sync_run_id": 1234567890
  }
}