POpolytomic
Bulk Sync

Cancel Bulk Sync

Changed on

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

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

The active execution of this bulk sync ID will be cancelled.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": {
    "message": "Cancellation requested"
  }
}

Changes

  • 61c2b96f65baRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status