POST
CustomerStatuses.Remove
Alias of CustomerStatuses.Delete. Remove a custom Customer Status from user_detail settings.
Permissions
- User must be logged in with a valid bearer token.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Removes the requested CustomerStatuses record when the user has permission.
Push Service
Pushes event customerstatuses.delete.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 |
|---|---|---|---|
data_namepost | string | fff121 | Custom status name to delete. Same dashboard field as delete_custom_customer_status. |
Optional Parameters
No optional body parameters are defined for this function.
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/CustomerStatuses.Remove",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"data_name": "fff121"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/CustomerStatuses.Remove",
"url_domain": "https:\/\/{domain}\/app\/CustomerStatuses.Remove"
}Endpoint
POST /app/CustomerStatuses.Remove
POST https://{user}.bull36.com/app/CustomerStatuses.Remove
POST https://{domain}/app/CustomerStatuses.RemoveSample Output
{
"success": 1,
"message": "Success",
"name_en": "fff121",
"socket_event": "customerstatuses.delete.deleted"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ data_name: 'fff121' });
const res = await fetch('/app/CustomerStatuses.Remove', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());Error Example
{
"success": 0,
"message": "Default customer statuses cannot be deleted."
}