Skip to navigation
API ReferenceSchemas

Delete Schema Field

Removes a user-defined field from a schema.

Only user-defined fields — those created via POST /api/connections/{connection_id}/schemas/{schema_id}/fields — can be removed through this endpoint. Fields detected automatically from the source cannot be deleted here; they are managed through schema refresh.

🚧 Deleting a field that is referenced in an active sync mapping may cause that sync to error on its next execution. Remove or update any dependent mappings before deleting the field.

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 field belongs to.
field_idstringRequired

Identifier of the user-defined field to delete.

Headers

X-Polytomic-VersionstringRequired

Response headers

locationstringOptional

Response

Accepted

Errors

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