Bulk Sync

Update Bulk Sync Schemas

Changed on Oct 23, 2026

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.

patch/api/bulk/syncs/{id}/schemas

Request

Base URL
https://app.polytomic.com
Auth
- HTTP bearer
- or HTTP basic

Path parameters

idstring uuid required

Unique identifier of the bulk sync

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

Example request

{
  "schemas": [
    {
      "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
      "destination_history_output_name": "contact__history",
      "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

Example response

{
  "data": [
    {
      "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
      "destination_history_output_name": "contact__history",
      "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"
    }
  ]
}

Changes

Oct 23, 202663750866d2b0 Revision changes
- info
  the request optional property // became read-only
- info
  the request optional property //// became read-only
- info
  the request optional property // became read-only
- info
  the response optional property // became read-only for the status
- info
  the response optional property //// became read-only for the status
- info
  the response optional property // became read-only for the status
Oct 21, 202661c2b96f65ba Revision changes
- breaking
  added to the //// request property allOf list
- breaking
  removed the enum value ArrayContains of the request property ////
- breaking
  removed the enum value ArrayDoesNotContain of the request property ////
- breaking
  removed the enum value Between of the request property ////
- breaking
  removed the enum value Equality of the request property ////
- breaking
  removed the enum value False of the request property ////
- breaking
  removed the enum value GreaterThan of the request property ////
- breaking
  removed the enum value GreaterThanEqual of the request property ////
- breaking
  removed the enum value InTheLast of the request property ////
- breaking
  removed the enum value Inequality of the request property ////
- breaking
  removed the enum value IsNotNull of the request property ////
- breaking
  removed the enum value IsNull of the request property ////
- breaking
  removed the enum value LessThan of the request property ////
- breaking
  removed the enum value LessThanEqual of the request property ////
- breaking
  removed the enum value OnOrAfter of the request property ////
- breaking
  removed the enum value OnOrBefore of the request property ////
- breaking
  removed the enum value RelativeOnOrAfter of the request property ////
- breaking
  removed the enum value RelativeOnOrBefore of the request property ////
- breaking
  removed the enum value StringContains of the request property ////
- breaking
  removed the enum value StringDoesNotContain of the request property ////
- breaking
  removed the enum value StringDoesNotEndWith of the request property ////
- breaking
  removed the enum value StringDoesNotStartWith of the request property ////
- breaking
  removed the enum value StringEndsWith of the request property ////
- breaking
  removed the enum value StringLike of the request property ////
- breaking
  removed the enum value StringMatchesTrimmed of the request property ////
- breaking
  removed the enum value StringNotLike of the request property ////
- breaking
  removed the enum value StringNotOneOf of the request property ////
- breaking
  removed the enum value StringOneOf of the request property ////
- breaking
  removed the enum value StringStartsWith of the request property ////
- breaking
  removed the enum value True of the request property ////
- breaking
  the //// request property type changed from string to no type
- breaking
  the //// response's property type changed from string to no type for status
- info
  added to the //// response property allOf list for the response status
- info
  removed the ArrayContains enum value from the //// response property for the response status
- info
  removed the ArrayDoesNotContain enum value from the //// response property for the response status
- info
  removed the Between enum value from the //// response property for the response status
- info
  removed the Equality enum value from the //// response property for the response status
- info
  removed the False enum value from the //// response property for the response status
- info
  removed the GreaterThan enum value from the //// response property for the response status
- info
  removed the GreaterThanEqual enum value from the //// response property for the response status
- info
  removed the InTheLast enum value from the //// response property for the response status
- info
  removed the Inequality enum value from the //// response property for the response status
- info
  removed the IsNotNull enum value from the //// response property for the response status
- info
  removed the IsNull enum value from the //// response property for the response status
- info
  removed the LessThan enum value from the //// response property for the response status
- info
  removed the LessThanEqual enum value from the //// response property for the response status
- info
  removed the OnOrAfter enum value from the //// response property for the response status
- info
  removed the OnOrBefore enum value from the //// response property for the response status
- info
  removed the RelativeOnOrAfter enum value from the //// response property for the response status
- info
  removed the RelativeOnOrBefore enum value from the //// response property for the response status
- info
  removed the StringContains enum value from the //// response property for the response status
- info
  removed the StringDoesNotContain enum value from the //// response property for the response status
- info
  removed the StringDoesNotEndWith enum value from the //// response property for the response status
- info
  removed the StringDoesNotStartWith enum value from the //// response property for the response status
- info
  removed the StringEndsWith enum value from the //// response property for the response status
- info
  removed the StringLike enum value from the //// response property for the response status
- info
  removed the StringMatchesTrimmed enum value from the //// response property for the response status
- info
  removed the StringNotLike enum value from the //// response property for the response status
- info
  removed the StringNotOneOf enum value from the //// response property for the response status
- info
  removed the StringOneOf enum value from the //// response property for the response status
- info
  removed the StringStartsWith enum value from the //// response property for the response status
- info
  removed the True enum value from the //// response property for the response status

Operation history (3 revisions)