POST
/
syncs
/
{id}
/
cancel
Cancel Sync
curl --request POST \
  --url https://api.withterminal.com/tsp/v1/syncs/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
  "message": "Sync cancellation requested"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Connection-Token
string
required

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

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Path Parameters

​
id
string
required

The ID of the sync job to retry

Response

200
application/json

OK

The response is of type object.