POST

Folders.Add

Create a customer folder/status group. Validates names, runs folders.add.created, and emits realtime folders.add.created.

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 Folders record or sends the requested data after validation.

Push Service

Pushes event folders.add.created to users who should see this change.

Automation

Runs automation event folders.add.created with the record id and submitted parameters after the action succeeds.

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

NameTypeSampleExplanation
name_he
post
stringDemoHebrew folder name.

Optional Parameters

NameTypeSampleWhat it gives
status
post
int|string1Optional status/value field when this route supports it.
customer_id
post
int456Customer id when this route connects a customer to this resource.

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

Endpoint

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

Sample Output

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

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('name_he', 'Demo');
body.set('name_en', 'Demo');
const res = await fetch('/app/Folders.Add', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

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