v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Data Management

Cancel Sync

Cancel a sync job mid-way through. This is useful for cancelling syncs that are no longer needed. Cancelled syncs will be marked as failed and can be retried.

post/syncs/{id}/cancel

Headers

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

The token returned when a user authenticated their account. This authorizes access to a specific account.

Response

OK

idstring ulid
messagestring

Example response

{
  "id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
  "message": "Sync cancellation requested"
}