Skip to content
XOS Developers

Delete a custom field definition

Platform module

DELETE/custom-field-definitions/{id}customFieldDefinitions.delete

A custom field on a built-in resource. Soft-deletes the custom field definition: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.custom_fields.write.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

customFieldDefinitions.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the custom field definition.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/custom-field-definitions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.customFieldDefinitions.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.custom_field_definitions.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos custom-field-definitions delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f