POST

Sheets.Add

Create a new sheet with one empty table. Only the main user or a manager can create sheets. Stores org_id on the sheet. Same as dashboard New Sheet.

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

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

  • 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.
  • Permission matches dashboard sheets_can_create (owner / member admin).
  • After success, open /dashboard/sheets/view/{id} or call Sheets.Get.
  • Required: name. Optional: name_he.

Required Parameters

NameTypeSampleExplanation
name
post
stringMonthly KPISheet name.

Optional Parameters

NameTypeSampleWhat it gives
name_he
post
stringKPI חודשיOptional Hebrew name.

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

Endpoint

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

Sample Output

{
    "success": 1,
    "id": 12,
    "data": {
        "id": 12,
        "org_id": 10,
        "name": "Monthly KPI"
    }
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('name', 'Monthly KPI');

const res = await fetch('/app/Sheets.Add', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Permission Denied"
}