Cancel a running sync

curl --request POST \
  --url https://app.getcensus.com/api/v1/sync_runs/{sync_run_id}/cancel \
  --header 'Authorization: Bearer <token>'

{
  "status": "cancelled",
  "data": {}
}

POST

sync_runs

{sync_run_id}

cancel

Cancel a running sync

curl --request POST \
  --url https://app.getcensus.com/api/v1/sync_runs/{sync_run_id}/cancel \
  --header 'Authorization: Bearer <token>'

{
  "status": "cancelled",
  "data": {}
}

Authorization

string

header

required

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

sync_run_id

integer

required

ID of the sync run

Successfully cancelled the sync

The response is of type object.