Update Bulk Sync Schema | Polytomic Docs

curl -X PATCH https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{}'

{
  "data": {
    "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
    "destination_history_output_name": "contact__history",
    "disable_data_cutoff": false,
    "enabled": true,
    "history_enabled": false,
    "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.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic 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

history_enabledboolean or nullOptional

Whether a companion history table is maintained beside this schema’s output. Requires a replicate-mode sync to a destination reporting supports_history_mode. Omit to keep the current value.

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

User-specified override for the destination object name

Response

dataobjectOptional

The bulk sync schema

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors