Cancel Bulk Sync Execution

Requests cancellation of a specific bulk sync execution.

Cancellation is asynchronous. A successful response means the cancellation signal has been queued; the execution continues to run until the signal is processed. Poll GET /api/bulk/syncs/{id}/executions/{exec_id} until the execution reaches a terminal state (completed, canceled, or failed) to confirm cancellation has taken effect.

Requests cancellation of a specific bulk sync execution. Cancellation is asynchronous. A successful response means the cancellation signal has been queued; the execution continues to run until the signal is processed. Poll `GET /api/bulk/syncs/{id}/executions/{exec_id}` until the execution reaches a terminal state (`completed`, `canceled`, or `failed`) to confirm cancellation has taken effect.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

The bulk sync ID.

exec_idstringRequiredformat: "uuid"

The execution ID to cancel.

Response

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors