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

Delete Schema Field

DELETE
https://app.polytomic.com/api/connections/:connection_id/schemas/:schema_id/fields/:field_id
DELETE
/api/connections/:connection_id/schemas/:schema_id/fields/:field_id
$curl -X DELETE https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/public.users/fields/first_name \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{}
Removes a user-defined field from a schema. Only user-defined fields — those created via [`POST /api/connections/{connection_id}/schemas/{schema_id}/fields`](../../../../../../../api-reference/schemas/upsert-field) — 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.
Was this page helpful?
Previous

Patch Schema Field

Next

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

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped 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-VersionstringOptional

Response headers

locationstring

Response

Accepted

Errors

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