v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBBulk Sync
Cancel Bulk Sync Schema
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.
post/api/bulk/syncs/{id}/schemas/{schema_id}/cancel
Path parameters
idstring uuid required
The bulk sync ID.
Example:248df4b7-aa70-47b8-a036-33ac447e668d
The bulk sync ID.
schema_idstring required
The schema ID to cancel for the bulk sync.
The schema ID to cancel for the bulk sync.
Headers
X-Polytomic-Versionstring
Response
OK
Example response
{
"data": {
"message": "Cancellation requested"
}
}