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

# Activate Bulk Sync

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

Sets whether a bulk sync is active.

Only active syncs are eligible to execute on their configured schedule.
Deactivating a sync prevents future scheduled runs and requests cancellation of
any execution that is currently in progress.

> 📘 To start or stop a running execution directly, use
> [`POST /api/bulk/syncs/{id}/executions`](../../../../../api-reference/bulk-sync/start)
> or
> [`POST /api/bulk/syncs/{id}/cancel`](../../../../../api-reference/bulk-sync/cancel).

## Path parameters

- `id` string, uuid, required

## Headers

- `X-Polytomic-Version` string

## Request body

- ActivateSyncInput
  - `active` boolean, required

## Response `200`

OK

- ActivateSyncEnvelope
  - `data` ActivateSyncOutput
    - `active` boolean
    - `id` string, uuid

## 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)