Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Bulk Sync

Update Bulk Sync Schema

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.

put/api/bulk/syncs/{id}/schemas/{schema_id}

Path parameters

idstring uuid required

Unique identifier of the bulk sync.

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

Unique identifier of the bulk sync.

schema_idstring required

Source-side schema identifier.

Example:contact

Source-side schema identifier.

Headers

X-Polytomic-Versionstring

Request body

data_cutoff_timestampstring date-time nullable

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

disable_data_cutoffboolean

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

enabledboolean

Whether this schema is included in sync runs.

partition_keystring

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

tracking_fieldstring

Source field used to detect changes between incremental sync runs.

user_output_namestring

Example request

{
  "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
  "enabled": true,
  "fields": [
    {
      "enabled": true,
      "id": "email",
      "user_output_name": "my_email"
    }
  ],
  "filters": [
    {
      "field_id": "field1",
      "value": "value"
    }
  ],
  "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"
  }
}