POST

Sheets.Share

Share a sheet with another team member as viewer or editor. Only the main user or a manager can share. The share row stores org_id. Same as dashboard share on sheets/view/{id}.

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

Runs the Sheets.Share function and returns JSON.

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.
role: viewer (default) or editor.
Aliases: id → sheet_id, member_id → user_id.

Required Parameters

Name	Type	Sample	Explanation
`sheet_id` post	int	`12`	Sheet id to share. Alias: id.

Optional Parameters

Name	Type	Sample	What it gives
`role` post	string	`editor`	viewer or editor. Default viewer.

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.Share",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "sheet_id": "12",
        "role": "editor"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Sheets.Share",
    "url_domain": "https:\/\/{domain}\/app\/Sheets.Share"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "shares": [
        {
            "user_id": 47,
            "role": "editor",
            "org_id": 10
        }
    ]
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('sheet_id', '12');
body.set('role', 'editor');

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

Error Example

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