Skip to navigation
API ReferenceModel 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.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"
Model sync ID

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
activebooleanRequired
Whether the model sync should be active

Response

OK
dataobjectOptional
The sync's updated active state

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error