Update Bulk Sync Schemas | Polytomic Docs

Patches one or more schemas on a bulk sync at once.

Only schemas explicitly included in the request body are modified; schemas omitted from the request are left unchanged. This makes PATCH the right choice when you want to update a subset of tables without affecting the rest of the sync’s schema configuration.

Each schema in the request is saved with the enabled and partition_key values you send and with all of its fields enabled. Its other settings, such as its tracking field and data cutoff, are cleared.

📘 To change one schema’s enabled and partition_key while keeping its other settings, use PATCH /api/bulk/syncs/{id}/schemas/{schema_id} instead. It also enables all of the schema’s fields.

Patches one or more schemas on a bulk sync at once. Only schemas explicitly included in the request body are modified; schemas omitted from the request are left unchanged. This makes PATCH the right choice when you want to update a subset of tables without affecting the rest of the sync's schema configuration. Each schema in the request is saved with the `enabled` and `partition_key` values you send and with all of its fields enabled. Its other settings, such as its tracking field and data cutoff, are cleared. > 📘 To change one schema's `enabled` and `partition_key` while keeping its > other settings, use > [`PATCH /api/bulk/syncs/{id}/schemas/{schema_id}`](../../../../../api-reference/bulk-sync/schemas/update) > instead. It also enables all of the schema's fields.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequired

Request

This endpoint expects an object.

schemaslist of objects or nullOptional

Response

datalist of objects or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error