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.
- 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.
- 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
| Name | Type | Sample | Explanation |
|---|---|---|---|
name_hepost | string | Demo | Hebrew folder name. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
statuspost | int|string | 1 | Optional status/value field when this route supports it. |
customer_idpost | int | 456 | Customer id when this route connects a customer to this resource. |
Authentication
Send the bearer token returned by Login in the request header.
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.AddSample 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"
}