Update Bulk Sync Schemas
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.
Within each provided schema, omitting fields enables all available fields on
that schema. To control which fields are enabled, include the fields array
with explicit enabled values for each field. Primary-key fields stay enabled
while their schema is enabled, even when the request sets enabled: false for
them.
output_name and destination_history_output_name on a schema, and
output_name on a field, are computed by Polytomic and ignored on input. Set
user_output_name to rename a destination object or field.
The response contains every schema on the bulk sync after the update, not only the schemas included in the request.
📘 To replace a single schema’s configuration in full (clearing any fields you omit), use
PUT /api/bulk/syncs/{id}/schemas/{schema_id}instead.
Authentication
Basic organization-scoped API key
Path parameters
Headers
Request
Schemas to patch. Schemas are matched by id; only schemas present in this list are updated.
