POST
CustomerStatuses.Add
Add a custom Customer Status. Same payload as dashboard custom_customer_status_form (add): name + status_color.
Permissions
- User must be logged in with a valid bearer token.
- The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Creates a CustomerStatuses record or sends the requested data after validation.
Push Service
Pushes event customerstatuses.add.created 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.
- On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
- Send parameters as POST body fields exactly as documented.
- Send date/time values in UTC Y-m-d H:i:s format when a date or datetime field is used.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
namepost | string | VIP | Status label. Dashboard field name. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
status_colorpost | string | #000000 | Status color. Dashboard default is #000000. |
Authentication
Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/CustomerStatuses.Add",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"name": "VIP",
"status_color": "#000000"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/CustomerStatuses.Add",
"url_domain": "https:\/\/{domain}\/app\/CustomerStatuses.Add"
}Endpoint
POST /app/CustomerStatuses.Add
POST https://{user}.bull36.com/app/CustomerStatuses.Add
POST https://{domain}/app/CustomerStatuses.AddSample Output
{
"success": 1,
"message": "Success",
"name_en": "VIP",
"socket_event": "customerstatuses.add.created"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ name: 'VIP', status_color: '#000000' });
const res = await fetch('/app/CustomerStatuses.Add', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());Error Example
{
"success": 0,
"message": "Missing required parameter: name"
}