For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Bulk Syncs
      • POSTCreate Bulk Sync
      • GETGet Bulk Sync
      • PUTUpdate Bulk Sync
      • DELDelete Bulk Sync
      • POSTActivate Bulk Sync
      • POSTCancel Bulk Sync
      • POSTStart Bulk Sync Execution
      • GETGet Bulk Sync Status
      • GETGet Bulk Source
      • GETGet Bulk Destination
        • GETGet Bulk Sync Schemas
        • PATCHUpdate Bulk Sync Schemas
        • GETGet Bulk Sync Schema
        • PUTUpdate Bulk Sync Schema
        • POSTCancel Bulk Sync Schema
Logo
Log inBook a demo
API ReferenceBulk SyncSchemas

Update Bulk Sync Schema

PUT
https://app.polytomic.com/api/bulk/syncs/:id/schemas/:schema_id
PUT
/api/bulk/syncs/:id/schemas/:schema_id
$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 '{}'
1{
2  "data": {
3    "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
4    "disable_data_cutoff": false,
5    "enabled": true,
6    "id": "Contact",
7    "output_name": "contact",
8    "partition_key": "email",
9    "tracking_field": "updated_at",
10    "user_output_name": "my_contact",
11    "fields": [
12      {
13        "enabled": true,
14        "id": "email",
15        "obfuscated": false,
16        "output_name": "email",
17        "user_output_name": "my_email"
18      }
19    ],
20    "filters": [
21      {
22        "function": "Equality",
23        "field_id": "field1",
24        "value": null
25      }
26    ]
27  }
28}
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.
Was this page helpful?
Previous

Cancel Bulk Sync Schema

Next

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.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the bulk sync.
schema_idstringRequired

Source-side schema identifier.

Headers

X-Polytomic-VersionstringOptional

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

OK
dataobject

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error