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
      • POSTUpsert Schema Fields
      • DELDelete Schema Field
      • PATCHPatch Schema Field
      • PUTSet Primary Keys
      • DELReset Primary Keys
      • POSTRefresh Connection Schema
      • GETGet Schema Status
      • GETGet Schema
      • GETGet Schema Records
Logo
Log inBook a demo
API ReferenceSchemas

Patch Schema Field

PATCH
https://app.polytomic.com/api/connections/:connection_id/schemas/:schema_id/fields/:field_id
PATCH
/api/connections/:connection_id/schemas/:schema_id/fields/:field_id
$curl -X PATCH https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/schema_id/fields/field_id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "data": {
3    "association": {
4      "id": "customer_account",
5      "name": "Customer Account",
6      "reference_to": [
7        "accounts",
8        "users"
9      ],
10      "referenced_field": "account_id"
11    },
12    "id": "email",
13    "is_primary_key": true,
14    "name": "Email",
15    "path": "$.contact.email",
16    "remote_type": "varchar(255)",
17    "type": "string",
18    "user_managed": true,
19    "values": [
20      {
21        "label": "Personal Email",
22        "value": "personal@example.com"
23      },
24      {
25        "label": "Work Email",
26        "value": "work@example.com"
27      }
28    ]
29  }
30}
Edits a single field on a schema, creating an override for a detected field if needed.
Was this page helpful?
Previous

Set Primary Keys

Next

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

connection_idstringRequiredformat: "uuid"
Connection holding the schema.
schema_idstringRequired
Schema identifier.
field_idstringRequired
Field identifier within the schema.

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
definitionobjectOptional
exampleanyOptional
Sample value surfaced in the UI.
labelstring or nullOptional

Human-readable label for the field.

pathstring or nullOptional

JSONPath used to extract the field from each source record; only meaningful for document-style backends. Pass an empty string to clear an existing path.

typestring or nullOptional

One of: string, number, boolean, datetime, array, object, binary. Changing the type without supplying a matching definition clears any prior detailed type metadata.

Response

OK
dataobject

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error