POST
Fields.Delete
Alias of Fields.Remove. Remove a customer custom field definition or hide/remove fixed customer field settings.
Permissions
- Only the organization owner or a manager can remove customer fields or field settings.
Action
- Removes the requested Fields record when the user has permission.
Push Service
Pushes event fields.remove.deleted to users who should see this change.
Automation
No automation is run for this function.
Special Instructions
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- Send parameters as POST body fields exactly as documented.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
field_namepost | string | a-1710000000 | Custom field storage key to remove. For fixed/regular fields, send field_key instead. Aliases: name, key. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
field_kindpost | string | custom | custom removes a custom field definition. fixed, regular, or common removes settings for an existing fixed field. Defaults to custom. |
field_keypost | string | phone | Fixed/regular customer field key when field_kind=fixed. |
folder_idpost | int | 1 | For fixed/regular fields, remove from this folder field list. |
remove_customer_valuespost | int | 0 | Custom fields only. Set 1 to also remove this key from contact extra_fields. Requires confirm_remove_values=1. |
confirm_remove_valuespost | int | 0 | Safety confirmation before deleting stored customer custom-field values. |
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Fields.Delete",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"field_name": "a-1710000000"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Fields.Delete",
"url_domain": "https:\/\/{domain}\/app\/Fields.Delete"
}Endpoint
POST /app/Fields.Delete
POST https://{user}.bull36.com/app/Fields.Delete
POST https://{domain}/app/Fields.DeleteSample Output
{
"success": 1,
"message": "Field removed",
"field_kind": "custom",
"field_name": "a-1710000000",
"socket_event": "fields.remove.deleted",
"automation_event": null
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ field_name: 'a-1710000000' });
const res = await fetch('/app/Fields.Remove', { method: 'POST', headers: { Authorization: `Bearer ${token}` }, body });
const data = await res.json();
console.log(data);Error Example
{
"success": "0",
"error": "missing_required_parameter",
"message": "Missing required parameter: field_name"
}