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

# Start Sync

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

Starts a new execution of a model sync.

> 🚧 Force full resync
>
> Use caution when setting the `resync` parameter to `true`. This will force a full resync of the data from the source system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended to only use this option when necessary.

## Path parameters

- `id` string, uuid, required

## Headers

- `X-Polytomic-Version` string

## Request body

- StartSyncRequest
  - `identities` string[], nullable
  - `resync` boolean
  - `test` boolean

## Response `200`

OK

- StartSyncResponseEnvelope
  - `data` StartSyncResponseSchema
    - `created_at` string, date-time
    - `id` string, uuid — Execution ID
    - `status` 'created' | 'scheduled' | 'queued' | 'waiting' | 'running' | 'processing' | 'canceling' | 'canceled' | 'completed' | 'failed' | 'interrupted'

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `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/b509e00e80aa/schema)