WIwithterminal
Data Management

Cancel Sync

Changed on

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

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/syncs/{id}/cancel
  • Auth
    HTTP bearer

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"
}

Changes

  • 71081936e1bdRevision changes
    • warning

      added the new oauth_client_id_unknown enum value to the response property for the response status

    • warning

      added the new provider_timeout enum value to the response property for the response status

    • info

      added the non-success response with the status