---
title: "Cancel Bulk Sync"
method: POST
path: "/api/bulk/syncs/{id}/cancel"
tags: ["Bulk Sync"]
---

# Cancel Bulk Sync

`POST /api/bulk/syncs/{id}/cancel`

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.

## Path parameters

- `id` string, uuid, required — The active execution of this bulk sync ID will be cancelled.

## Headers

- `X-Polytomic-Version` string

## Response `200`

OK

- CancelBulkSyncResponseEnvelope
  - `data` CancelBulkSyncResponse
    - `message` string

## Other responses

- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/polytomic/apis/polytomic-api.md) · [All operations](https://skmtc.net/polytomic/apis/polytomic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polytomic/polytomic-api/versions/5e9bcd4cfb2d/schema)
