Skip to navigation

Update Bulk Sync Schema

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

Authentication

AuthorizationBasic

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

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the bulk sync
schema_idstringRequired

Source-side schema identifier

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
data_cutoff_timestampdatetime or nullOptional

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

delete_propagationenumOptional

Per-schema delete propagation: inherit uses the destination setting, soft marks deleted rows, and hard removes them. Requires a destination that supports the selected mode. Omit to keep the current value; send inherit to reset it.

Allowed values:
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
excluded_fieldslist of strings or nullOptional

IDs of fields that are never synced, even when automatically_add_new_fields would add them. Each must be an existing field that is not part of the primary key, the tracking field, or the partition key. Omit to keep the current list; send an empty list to clear it.

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

history_enabledboolean or nullOptional

Whether a companion history table is maintained beside this schema’s output. Requires a replicate-mode sync to a destination reporting supports_history_mode. Omit to keep the current value.

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

User-specified override for the destination object name

Response

OK
dataobjectOptional
The bulk sync schema

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error