Start Sync | Polytomic Docs

Starts a new execution of a model sync.

🚧 Force full resync

Use caution when setting the resync parameter to true. This will force a full resync of the data from the source system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended to only use this option when necessary.

Starts a new execution of a model sync. > 🚧 Force full resync > > Use caution when setting the `resync` parameter to `true`. This will force a full resync of the data from the source system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended to only use this option when necessary.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

identitieslist of strings or nullOptional

resyncbooleanOptionalDefaults to false

testbooleanOptionalDefaults to false

Response

dataobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error

1	curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \
2	-H "X-Polytomic-Version: X-Polytomic-Version" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{}'

1	{
2	"data": {
3	"created_at": "2024-01-01T00:00:00Z",
4	"id": "7f3e9c2a-4b8d-4f1e-a9c3-6d5e2f8b1a7c",
5	"status": "created"
6	}
7	}