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

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

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

activebooleanRequired

Response

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"active": false
>	}'

$	curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"active": false
>	}'

Activate Bulk Sync

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors

1	{
2	"data": {
3	"active": false,
4	"id": "248df4b7-aa70-47b8-a036-33ac447e668d"
5	}
6	}