v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBBulk Sync
Cancel Bulk Sync
Requests cancellation of any running executions on a bulk sync.
Cancellation is asynchronous. A successful response means the cancellation signal has been queued; the running execution continues until the signal is processed. Poll GET /api/bulk/syncs/{id}/status until the current execution reaches a terminal state (completed, canceled, or failed) to confirm cancellation has taken effect.
post/api/bulk/syncs/{id}/cancel
Path parameters
idstring uuid required
The active execution of this bulk sync ID will be cancelled.
Example:248df4b7-aa70-47b8-a036-33ac447e668d
The active execution of this bulk sync ID will be cancelled.
Headers
X-Polytomic-Versionstring
Response
OK
Example response
{
"data": {
"message": "Cancellation requested"
}
}