Skip to navigation
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 or POST /api/bulk/syncs/{id}/cancel.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
activebooleanRequired

Response

OK
dataobjectOptional

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error