For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Bulk Syncs
      • POSTCreate Bulk Sync
      • GETGet Bulk Sync
      • PUTUpdate Bulk Sync
      • DELDelete Bulk Sync
      • POSTActivate Bulk Sync
      • POSTCancel Bulk Sync
      • POSTStart Bulk Sync Execution
      • GETGet Bulk Sync Status
      • GETGet Bulk Source
      • GETGet Bulk Destination
        • GETGet Bulk Sync Schemas
        • PATCHUpdate Bulk Sync Schemas
        • GETGet Bulk Sync Schema
        • PUTUpdate Bulk Sync Schema
        • POSTCancel Bulk Sync Schema
Logo
Log inBook a demo
API ReferenceBulk SyncSchemas

Cancel Bulk Sync Schema

POST
https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id/cancel
POST
/api/bulk/syncs/:id/schemas/:schema_id/cancel
$curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/schema_id/cancel \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "message": "Cancellation requested"
4  }
5}
Requests cancellation of any running executions for a specific schema on a bulk sync. Cancellation is asynchronous. A successful response means the cancellation signal for this schema has been queued; the schema's in-flight work continues until the signal is processed. Poll `GET /api/bulk/syncs/{id}/schemas/{schema_id}` and the parent execution via `GET /api/bulk/syncs/{id}/status` to confirm the schema has reached a terminal state.
Was this page helpful?
Previous

Get Bulk Sync Schedules

Next

Requests cancellation of any running executions for a specific schema on a bulk sync.

Cancellation is asynchronous. A successful response means the cancellation signal for this schema has been queued; the schema’s in-flight work continues until the signal is processed. Poll GET /api/bulk/syncs/{id}/schemas/{schema_id} and the parent execution via GET /api/bulk/syncs/{id}/status to confirm the schema has reached a terminal state.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
The bulk sync ID.
schema_idstringRequired
The schema ID to cancel for the bulk sync.

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobject

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error