Cancel a running sync
Use this endpoint to cancel a sync that is actively running.
Request schema
Path parameters
sync_run_id
integerrequired
ID of the sync run
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Http + 1.1
POST
https://app.getcensus.com/api/v1/sync_runs/{sync_run_id}/cancel
POST /api/v1/sync_runs/{sync_run_id}/cancel HTTP/1.1 Authorization: Bearer REPLACE_BEARER_TOKEN Host: app.getcensus.com
Responses
200
Successfully cancelled the sync
404
Resource not found.
200
status
string
example:
data
object
404
status
integer
HTTP status code.
enum:
{ "status": "cancelled", "data": {} }