v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBBulk 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.
post/api/bulk/syncs/{id}/activate
Path parameters
idstring uuid required
Example:248df4b7-aa70-47b8-a036-33ac447e668d
Headers
X-Polytomic-Versionstring
Request body
Example request
{
"active": true
}Response
OK
Example response
{
"data": {
"id": "248df4b7-aa70-47b8-a036-33ac447e668d"
}
}