Schemas

Upsert Schema Fields

Changed on

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.

post/api/connections/{connection_id}/schemas/{schema_id}/fields

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

connection_idstring uuid required

Unique identifier of the connection

Example:248df4b7-aa70-47b8-a036-33ac447e668d
schema_idstring required

Identifier of the schema the fields belong to

Example:public.users

Headers

X-Polytomic-Versionstring

Request body

Response

Accepted

Changes

    • breaking

      added to the // request property allOf list

    • breaking

      removed subschema #1 subschema #2 from the // request property oneOf list

    • info

      added the new optional request property //