POST

Folders.SubStatus.Edit

Edit an internal sub-status. This is the short alias of Folders.InternalSubStatus.Edit. It updates an all_status row with type internal_sub_status. It is a settings action only and does not run customer automation.

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.SubStatus.Edit function and returns JSON.

Push Service

Pushes event folders.internalsubstatus.edit.updated 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
status_id
post
int125Sub-status id. Aliases: sub_status_id, id, data_id, sub_status_data_id.

Optional Parameters

NameTypeSampleWhat it gives
parent_status_id
post
int124Move this sub-status under another internal status. Aliases: parent_id, patent_status_id, data_patent_id.
name
post
stringWaiting Tax FormNew sub-status name. Aliases: sub_status_name, internal_sub_staus_name, name_en, name_he.
color
post
color string#9b51e0Hex color for the sub-status. Aliases: sub_status_color_name, internal_sub_staus_color.
status_order
post
int1Sort 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.SubStatus.Edit",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "status_id": "125",
        "name": "Waiting Tax Form"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Folders.SubStatus.Edit",
    "url_domain": "https:\/\/{domain}\/app\/Folders.SubStatus.Edit"
}

Endpoint

POST /app/Folders.SubStatus.Edit
POST https://{user}.bull36.com/app/Folders.SubStatus.Edit
POST https://{domain}/app/Folders.SubStatus.Edit

Sample Output

{
    "success": 1,
    "message": "Folders.InternalSubStatus.Edit updated",
    "id": "125",
    "status_id": "125",
    "automation_event": null,
    "socket_event": "folders.internalsubstatus.edit.updated"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('status_id', '125');
body.set('name', 'Waiting Tax Form');

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

Error Example

{
    "success": 0,
    "message": "Missing required parameter: status_id"
}