Update Bulk Sync Schema | Polytomic Docs

Replaces the configuration of a single schema on a bulk sync.

This is a full replacement: every field in the request body is written to the schema, and any field you omit is cleared or reset to its default. Fetch the current configuration with GET /api/bulk/syncs/{id}/schemas/{schema_id} first if you want to preserve existing settings while changing only a subset.

Omitting fields enables all available fields on the schema. To control which fields are enabled, include the fields array with explicit enabled values.

📘 To update multiple schemas in a single request without affecting others, use the partial-update endpoint PATCH /api/bulk/syncs/{id}/schemas instead.

Replaces the configuration of a single schema on a bulk sync. This is a full replacement: every field in the request body is written to the schema, and any field you omit is cleared or reset to its default. Fetch the current configuration with [`GET /api/bulk/syncs/{id}/schemas/{schema_id}`](../../../../../../api-reference/bulk-sync/schemas/get) first if you want to preserve existing settings while changing only a subset. Omitting `fields` enables all available fields on the schema. To control which fields are enabled, include the `fields` array with explicit `enabled` values. > 📘 To update multiple schemas in a single request without affecting others, > use the partial-update endpoint > [`PATCH /api/bulk/syncs/{id}/schemas`](../../../../../../api-reference/bulk-sync/schemas/patch) > instead.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the bulk sync.

schema_idstringRequired

Source-side schema identifier.

Request

This endpoint expects an object.

data_cutoff_timestampstring or nullOptionalformat: "date-time"

Per-schema cutoff. Records older than this timestamp are excluded from sync runs.

disable_data_cutoffbooleanOptional

When true, the sync ignores any configured data_cutoff_timestamp for this schema.

enabledbooleanOptional

Whether this schema is included in sync runs.

fieldslist of objects or nullOptional

Field-level configuration. Supplying an empty list enables every field discovered on the source.

filterslist of objects or nullOptional

Row-level filters applied when reading from the source.

partition_keystringOptional

Source field used to partition rows when writing to the destination.

tracking_fieldstringOptional

Source field used to detect changes between incremental sync runs.

user_output_namestringOptional

Response

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -X PUT https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact \
2	-H "X-Polytomic-Version: X-Polytomic-Version" \
3	-H "Content-Type: application/json" \
4	-u "<username>:<password>" \
5	-d '{}'

1	{
2	"data": {
3	"data_cutoff_timestamp": "2023-04-25T12:00:00Z",
4	"disable_data_cutoff": false,
5	"enabled": true,
6	"id": "Contact",
7	"output_name": "contact",
8	"partition_key": "email",
9	"tracking_field": "updated_at",
10	"user_output_name": "my_contact",
11	"fields": [
12	{
13	"enabled": true,
14	"id": "email",
15	"obfuscated": false,
16	"output_name": "email",
17	"user_output_name": "my_email"
18	}
19	],
20	"filters": [
21	{
22	"function": "Equality",
23	"field_id": "field1"
24	}
25	]
26	}
27	}

Authentication

Path parameters

Headers

Request

Response

Errors