---
title: "Update Bulk Sync Schemas"
method: PATCH
path: "/api/bulk/syncs/{id}/schemas"
tags: ["Bulk Sync"]
---

# Update Bulk Sync Schemas

`PATCH /api/bulk/syncs/{id}/schemas`

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.

## Path parameters

- `id` string, uuid, required — Unique identifier of the bulk sync.

## Headers

- `X-Polytomic-Version` string

## Request body

- UpdateBulkSyncSchemasRequest
  - `schemas` BulkSchema[], nullable — Schemas to patch. Schemas are matched by id; only schemas present in this list are updated.
    - `data_cutoff_timestamp` string, date-time, nullable
    - `disable_data_cutoff` boolean
    - `enabled` boolean
    - `fields` BulkField[] — fields is not populated on the list endpoint and will be removed in a future version; retrieve individual schemas for fields.
      - `enabled` boolean
      - `id` string
      - `obfuscated` boolean
      - `output_name` string
      - `user_output_name` string
    - `filters` BulkFilter[] — filters is not populated on the list endpoint and will be removed in a future version; retrieve individual schemas for filters.
      - `field_id` string — Schema field ID to filter on.
      - `function` 'Equality' | 'Inequality' | 'IsNull' | 'IsNotNull' | 'True' | 'False' | 'OnOrAfter' | 'OnOrBefore' | 'GreaterThan' | 'GreaterThanEqual' | 'LessThan' | 'LessThanEqual' | 'StringContains' | 'StringStartsWith' | 'StringEndsWith' | 'StringDoesNotContain' | 'StringDoesNotStartWith' | 'StringDoesNotEndWith' | 'StringOneOf' | 'StringNotOneOf' | 'Between' | 'ArrayContains' | 'ArrayDoesNotContain' | 'InTheLast' | 'RelativeOnOrBefore' | 'RelativeOnOrAfter' | 'StringLike' | 'StringNotLike' | 'StringMatchesTrimmed', required
      - `value` string
    - `id` string
    - `output_name` string
    - `partition_key` string
    - `tracking_field` string
    - `user_output_name` string

## Response `200`

OK

- UpdateBulkSyncSchemasEnvelope
  - `data` BulkSchema[], nullable
    - `data_cutoff_timestamp` string, date-time, nullable
    - `disable_data_cutoff` boolean
    - `enabled` boolean
    - `fields` BulkField[] — fields is not populated on the list endpoint and will be removed in a future version; retrieve individual schemas for fields.
      - `enabled` boolean
      - `id` string
      - `obfuscated` boolean
      - `output_name` string
      - `user_output_name` string
    - `filters` BulkFilter[] — filters is not populated on the list endpoint and will be removed in a future version; retrieve individual schemas for filters.
      - `field_id` string — Schema field ID to filter on.
      - `function` 'Equality' | 'Inequality' | 'IsNull' | 'IsNotNull' | 'True' | 'False' | 'OnOrAfter' | 'OnOrBefore' | 'GreaterThan' | 'GreaterThanEqual' | 'LessThan' | 'LessThanEqual' | 'StringContains' | 'StringStartsWith' | 'StringEndsWith' | 'StringDoesNotContain' | 'StringDoesNotStartWith' | 'StringDoesNotEndWith' | 'StringOneOf' | 'StringNotOneOf' | 'Between' | 'ArrayContains' | 'ArrayDoesNotContain' | 'InTheLast' | 'RelativeOnOrBefore' | 'RelativeOnOrAfter' | 'StringLike' | 'StringNotLike' | 'StringMatchesTrimmed', required
      - `value` string
    - `id` string
    - `output_name` string
    - `partition_key` string
    - `tracking_field` string
    - `user_output_name` string

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/polytomic/apis/polytomic-api.md) · [All operations](https://skmtc.net/polytomic/apis/polytomic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polytomic/polytomic-api/versions/5e9bcd4cfb2d/schema)