Skip to main content
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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.withterminal.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Pattern: ^con_tkn_\S+$
Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Path Parameters

​
id
string<ulid>
required

The ID of the sync job to retry

Pattern: ^sync_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"sync_01GV12VR4DJP70GD1ZBK0SDWFH"

Response

OK

​
id
string<ulid>
Pattern: ^sync_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"sync_01GV12VR4DJP70GD1ZBK0SDWFH"

​
message
string
Example:

"Sync cancellation requested"