Rooms.Remove

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

• Removes the requested Rooms record when the user has permission.

Push Service

Pushes event rooms.deleted to users who should see this change.

Automation

Runs automation event rooms.deleted 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.

Required Parameters

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

Endpoint

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

Sample Output

{
    "success": 1,
    "id": "3710",
    "message": "Record removed successfully.",
    "automation_event": "rooms.deleted",
    "socket_event": "rooms.deleted"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
// Fill body fields from the Sample Request JSON above.
const res = await fetch('/app/Rooms.Remove', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Record was not found."
}