Patch Schema Field | Polytomic Docs

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 '{}'

{
  "data": {
    "association": {
      "id": "customer_account",
      "name": "Customer Account",
      "reference_to": [
        "accounts",
        "users"
      ],
      "referenced_field": "account_id"
    },
    "id": "email",
    "is_primary_key": true,
    "name": "Email",
    "path": "$.contact.email",
    "remote_type": "varchar(255)",
    "type": "string",
    "user_managed": true,
    "values": [
      {
        "label": "Personal Email",
        "value": "personal@example.com"
      },
      {
        "label": "Work Email",
        "value": "work@example.com"
      }
    ]
  }
}

Edits a single field on a schema, creating an override for a detected field if needed.

Authentication

AuthorizationBearer

Bearer user API key

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.

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

dataobject

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors