Update Bulk Sync Schemas | Polytomic Docs

curl -X PATCH https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas \
     -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",
      "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"
        }
      ]
    }
  ]
}

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.

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

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.

Request

This endpoint expects an object.

schemaslist of objects or nullOptional

Schemas to patch. Schemas are matched by id; only schemas present in this list are updated.

Response

datalist of objects or null

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