POST

Fields.Remove

Remove a customer field setting. For custom fields, this removes the custom field definition and order entry but keeps historical values on customers by default. To also delete stored customer values, send remove_customer_values=1 and confirm_remove_values=1. For fixed/regular fields, this hides or removes the field from folder/dashboard settings; the database field is not deleted.

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_name` post	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_kind` post	string	`custom`	custom removes a custom field definition. fixed, regular, or common removes settings for an existing fixed field. Defaults to custom.
`field_key` post	string	`phone`	Fixed/regular customer field key when field_kind=fixed.
`folder_id` post	int	`1`	For fixed/regular fields, remove from this folder field list.
`remove_customer_values` post	int	`0`	Custom fields only. Set 1 to also remove this key from contact extra_fields. Requires confirm_remove_values=1.
`confirm_remove_values` post	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.Remove",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "field_name": "a-1710000000"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Fields.Remove",
    "url_domain": "https:\/\/{domain}\/app\/Fields.Remove"
}

Endpoint

POST /app/Fields.Remove
POST https://{user}.bull36.com/app/Fields.Remove
POST https://{domain}/app/Fields.Remove

Sample 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"
}