POST

Folders.Status.Add

Add a customer status option inside a folder. This creates an all_status row with type customer_status and folder_id. It is a settings action only: no customer automation runs. Open UIs should refresh User.Basic after socket_event folders.status.add.created.

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

  • Runs the Folders.Status.Add function and returns JSON.

Push Service

Pushes event folders.status.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.
  • 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

NameTypeSampleExplanation
folder_id
post
int1Folder id where this status belongs. Alias: f_id.
name
post
stringNew LeadStatus label. You may also send name_en/name_he to set languages separately.

Optional Parameters

NameTypeSampleWhat it gives
color
post
color string#2f80edStatus color used by the UI. Alias: status_color.
status_order
post
int1Display order inside the folder status list. Alias: index_id.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Folders.Status.Add",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "folder_id": "1",
        "name": "New Lead",
        "color": "#2f80ed"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Folders.Status.Add",
    "url_domain": "https:\/\/{domain}\/app\/Folders.Status.Add"
}

Endpoint

POST /app/Folders.Status.Add
POST https://{user}.bull36.com/app/Folders.Status.Add
POST https://{domain}/app/Folders.Status.Add

Sample Output

{
    "success": 1,
    "message": "Folders.Status.Add created",
    "id": "123",
    "status_id": "123",
    "automation_event": null,
    "socket_event": "folders.status.add.created"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('folder_id', '1');
body.set('name', 'New Lead');
body.set('color', '#2f80ed');

const res = await fetch('/app/Folders.Status.Add', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Missing required parameter: folder_id, name"
}