Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Model Sync

Activate Sync

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 to stop a running execution.

post/api/syncs/{id}/activate

Path parameters

idstring uuid required
Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

activeboolean required

Example request

{
  "active": true
}

Response

OK

Example response

{
  "data": {
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}