> This page is for version 2023-04-25.
> For other versions, use one of these documentation indexes:
> - 2025-09-18 (default): https://apidocs.polytomic.com/2025-09-18/llms.txt
> - 2024-02-08: https://apidocs.polytomic.com/2024-02-08/llms.txt
> - 2023-04-25: https://apidocs.polytomic.com/2023-04-25/llms.txt
> - 2022-12-12: https://apidocs.polytomic.com/2022-12-12/llms.txt
> - 2021-05-23: https://apidocs.polytomic.com/2021-05-23/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.polytomic.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server.

# Update Bulk Sync Schema

PATCH https://app.polytomic.com/api/bulk/syncs/{id}/schemas/{schema_id}
Content-Type: application/json

Replaces the configuration of a single schema on a bulk sync.

Reference: https://apidocs.polytomic.com/2023-04-25/api-reference/bulk-sync/schemas/update

## Authentication

- `Authorization` header (basic auth, required) — This is the Polytomic deployment key (on-premises only)
- `Authorization` header (bearer token, required) — This is the Polytomic API key

## Request

### Path parameters

- `id` (string, required) — Unique identifier of the bulk sync.
- `schema_id` (string, required) — Source-side schema identifier.

### Body (application/json)

This endpoint expects a V3UpdateBulkSchema.

- `data_cutoff_timestamp` (datetime, optional, nullable) — Per-schema cutoff. Records older than this timestamp are excluded from sync runs.
- `disable_data_cutoff` (boolean, optional) — When true, the sync ignores any configured data_cutoff_timestamp for this schema.
- `enabled` (boolean, optional) — Whether this schema is included in sync runs.
- `fields` (list of V3UpdateBulkField, optional, nullable) — Field-level configuration. Supplying an empty list enables every field discovered on the source.
- `filters` (list of BulkFilter, optional, nullable) — Row-level filters applied when reading from the source.
- `history_enabled` (boolean, optional, nullable) — 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_key` (string, optional) — Source field used to partition rows when writing to the destination.
- `tracking_field` (string, optional) — Source field used to detect changes between incremental sync runs.
- `user_output_name` (string, optional)

## Response

### 200

OK

- `data` (V3BulkSchema, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

### 401 Unauthorized Error

Unauthorized

- `code` (integer, optional) — Application-specific error code.
- `context` (map from string to any, optional) — Application context.
- `error` (string, optional) — Error message.
- `status` (string, optional) — Status text.

### 403 Forbidden Error

Forbidden

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

### 404 Not Found Error

Not Found

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

### 500 Internal Server Error

Internal Server Error

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

## Types

### V3UpdateBulkField

- `enabled` (boolean, optional)
- `id` (string, optional)
- `obfuscated` (boolean, optional)
- `user_output_name` (string, optional)

### BulkFilter

- `function` (enum, required)
  - Allowed values: `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`
- `field_id` (string, optional) — Schema field ID to filter on.
- `value` (any, optional)

### V3BulkSchema

- `data_cutoff_timestamp` (datetime, optional, nullable)
- `destination_history_output_name` (string, optional, nullable) — Name of the companion history table. Present only when history is enabled on a destination that supports it.
- `disable_data_cutoff` (boolean, optional)
- `enabled` (boolean, optional)
- `history_enabled` (boolean, optional, nullable) — Whether a companion history table is maintained beside this schema's output, recording every version observed on successive runs. Requires a replicate-mode sync to a destination reporting supports_history_mode. Always present in responses; when patching, omit it to keep the current value.
- `id` (string, optional)
- `output_name` (string, optional)
- `partition_key` (string, optional)
- `tracking_field` (string, optional)
- `user_output_name` (string, optional)
- `fields` (list of V3BulkField, optional, deprecated) — fields is not populated on the list endpoint and will be removed in a future version; retrieve individual schemas for fields.
- `filters` (list of BulkFilter, optional, deprecated) — filters is not populated on the list endpoint and will be removed in a future version; retrieve individual schemas for filters.

### V3BulkField

- `enabled` (boolean, optional)
- `id` (string, optional)
- `obfuscated` (boolean, optional)
- `output_name` (string, optional)
- `user_output_name` (string, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "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
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact"

payload = {}
headers = {
    "X-Polytomic-Version": "X-Polytomic-Version"
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact';
const credentials = btoa("<username>:<password>");

const options = {
  method: 'PATCH',
  headers: {
    'X-Polytomic-Version': 'X-Polytomic-Version',
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Polytomic-Version", "X-Polytomic-Version")
	req.SetBasicAuth("<username>", "<password>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-Polytomic-Version"] = 'X-Polytomic-Version'
request.basic_auth("<username>", "<password>")
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact")
  .header("X-Polytomic-Version", "X-Polytomic-Version")
  .basicAuth("<username>", "<password>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Polytomic-Version' => 'X-Polytomic-Version',
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.PATCH);
request.AddHeader("X-Polytomic-Version", "X-Polytomic-Version");

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = [
  "X-Polytomic-Version": "X-Polytomic-Version",
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/contact")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```