POST

Folders.SubStatus.Remove

Remove an internal sub-status from folder settings. This is the short alias of Folders.InternalSubStatus.Remove. It deletes the 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.
  • 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

  • Runs the Folders.SubStatus.Remove function and returns JSON.

Push Service

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

Required Parameters

NameTypeSampleExplanation
status_id
post
int125Sub-status id. Aliases: sub_status_id, id, data_id, sub_status_data_id.

Optional Parameters

No optional body parameters are defined for this function.

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\/Folders.SubStatus.Remove",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "status_id": "125"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Folders.SubStatus.Remove",
    "url_domain": "https:\/\/{domain}\/app\/Folders.SubStatus.Remove"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Folders.InternalSubStatus.Remove removed",
    "id": "125",
    "status_id": "125",
    "automation_event": null,
    "socket_event": "folders.internalsubstatus.remove.deleted"
}

JavaScript Example

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

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