v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBBulk Sync
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.
📘 To replace a single schema's configuration in full (clearing any fields you omit), use PUT /api/bulk/syncs/{id}/schemas/{schema_id} instead.
patch/api/bulk/syncs/{id}/schemas
Path parameters
idstring uuid required
Unique identifier of the bulk sync.
Example:248df4b7-aa70-47b8-a036-33ac447e668d
Unique identifier of the bulk sync.
Headers
X-Polytomic-Versionstring
Request body
Example request
{
"schemas": [
{
"data_cutoff_timestamp": "2023-04-25T12:00:00Z",
"enabled": true,
"fields": [
{
"enabled": true,
"id": "email",
"output_name": "email",
"user_output_name": "my_email"
}
],
"filters": [
{
"field_id": "field1",
"value": "value"
}
],
"id": "Contact",
"output_name": "contact",
"partition_key": "email",
"tracking_field": "updated_at",
"user_output_name": "my_contact"
}
]
}Response
OK
Example response
{
"data": [
{
"data_cutoff_timestamp": "2023-04-25T12:00:00Z",
"enabled": true,
"fields": [
{
"enabled": true,
"id": "email",
"output_name": "email",
"user_output_name": "my_email"
}
],
"filters": [
{
"field_id": "field1",
"value": "value"
}
],
"id": "Contact",
"output_name": "contact",
"partition_key": "email",
"tracking_field": "updated_at",
"user_output_name": "my_contact"
}
]
}