Update Bulk Sync Schema | Polytomic Docs

curl -X PUT https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "data": {
    "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
    "disable_data_cutoff": false,
    "enabled": true,
    "id": "Contact",
    "output_name": "contact",
    "partition_key": "email",
    "tracking_field": "updated_at",
    "user_output_name": "my_contact",
    "fields": [
      {
        "enabled": true,
        "id": "email",
        "obfuscated": false,
        "output_name": "email",
        "user_output_name": "my_email"
      }
    ],
    "filters": [
      {
        "function": "Equality",
        "field_id": "field1",
        "value": null
      }
    ]
  }
}

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.

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}`](../../../../../../api-reference/bulk-sync/schemas/get) 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`](../../../../../../api-reference/bulk-sync/schemas/patch) > instead.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the bulk sync.

schema_idstringRequired

Source-side schema identifier.

Request

This endpoint expects an object.

data_cutoff_timestampdatetime or nullOptional

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

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.

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.

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

Response

dataobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors