Upsert Schema Fields

Creates or updates user-defined fields on a schema, matched by field_id. Fields are matched by `field_id`. Reusing an existing `field_id` updates that field; using a new `field_id` creates a new user-defined field. This makes the endpoint safe to retry when you are intentionally upserting the same field definitions. It is not a patch-by-position operation. If some fields succeed and others fail, the endpoint can return a partial success response. Validate the response status and message rather than assuming the whole batch was applied uniformly.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

connection_idstringRequiredformat: "uuid"
Unique identifier of the connection.
schema_idstringRequired
Identifier of the schema the fields belong to.

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
fieldslist of objects or nullOptional

Fields to create or update on the schema. Existing user-defined fields with the same field_id are replaced.

Response headers

locationstring

Response

Accepted

Errors

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