API ReferenceBulk Sync

Activate Bulk Sync

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

Authentication

AuthorizationBasic

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

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
activebooleanRequired

Response

OK
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error