POST

Folders.InternalStatus.Add

Add an internal status option for a folder. This creates an all_status row with type internal_status and folder_id. No customer automation runs because this only changes settings definitions.

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.InternalStatus.Add function and returns JSON.

Push Service

Pushes event folders.internalstatus.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 the internal status belongs. Alias: f_id.
name
post
stringWaiting For DocsInternal status label. Aliases: internal_staus, internal_status_name, name_en, name_he.

Optional Parameters

NameTypeSampleWhat it gives
color
post
color string#f2c94cStatus color. Alias: internal_staus_color.
status_order
post
int1Display order. Alias: index_id.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Folders.InternalStatus.Add",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "folder_id": "1",
        "name": "Waiting For Docs",
        "color": "#f2c94c"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Folders.InternalStatus.Add",
    "url_domain": "https:\/\/{domain}\/app\/Folders.InternalStatus.Add"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Folders.InternalStatus.Add created",
    "id": "124",
    "status_id": "124",
    "automation_event": null,
    "socket_event": "folders.internalstatus.add.created"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('folder_id', '1');
body.set('name', 'Waiting For Docs');
body.set('color', '#f2c94c');

const res = await fetch('/app/Folders.InternalStatus.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"
}