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

# Activate Sync

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

Sets whether a model sync is active.

Only active syncs execute on schedule or in response to a manual trigger. Set
`active` to `false` to pause a sync without deleting it.

> 📘 Deactivating a sync does not cancel an execution that is already in
> progress. Use [`POST /api/syncs/{id}/cancel`](../../../../api-reference/model-sync/cancel) to stop a
> running execution.

## 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
- `422` — Unprocessable Entity
- `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)