POST

Folders.Update

Update a customer folder/status group. Validates folder id and allowed fields, runs folders.edit.updated, and emits realtime folders.edit.updated.

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

  • Updates the requested Folders record after validating permissions and input fields.

Push Service

Pushes event folders.edit.updated to users who should see this change.

Automation

Runs automation event folders.edit.updated 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

NameTypeSampleExplanation
folder_id
post
int123Folder id.

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.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Folders.Update",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "folder_id": "123",
        "name_en": "Demo"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Folders.Update",
    "url_domain": "https:\/\/{domain}\/app\/Folders.Update"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Folders.Update updated",
    "id": "123",
    "automation_event": "folders.edit.updated",
    "socket_event": "folders.edit.updated"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('folder_id', '123');
body.set('name_en', 'Demo');
const res = await fetch('/app/Folders.Update', { 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"
}