Skip to navigation

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.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
The active execution of this bulk sync ID will be cancelled.

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobjectOptional

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error