Delete a customer custom field

Delete a custom field definition. All stored values for that field are also removed.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

customer:custom-fields:write

Path Parameters

Name	Type	Required	Description
`customFieldId`	string	Required	Custom field ID.

DELETEExample request

curl

curl -X DELETE "https://www.pxb.app/api/public/v1/customer-custom-fields/{customFieldId}" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Customer custom field deleted successfully.",
  "content": {}
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

xRM → Accounts → Custom fields

/xrm

Open the Custom fields dialog from the accounts table header.
Delete a field.