POST

Customer.Welcome

Return the logged-in customer and which client-portal modules are enabled (user_detail.client_module), same as Clientproject::welcome. Requires a Customer.Login bearer token. Staff tokens are rejected.

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 Customer.Welcome 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.
  • Use the Customer.Login token, not staff Login.
  • c_id is taken from the token. Do not send another customer id.
  • products and appointments are always listed on the dashboard welcome page; other modules follow client_module flags.

Required Parameters

No body parameters are required for this function.

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

Endpoint

POST /app/Customer.Welcome
POST https://{user}.bull36.com/app/Customer.Welcome
POST https://{domain}/app/Customer.Welcome

Sample Output

{
    "success": 1,
    "c_id": 12614595,
    "owner_id": 24552,
    "modules": {
        "tickets": true,
        "projects": true,
        "invoices": true,
        "files": true,
        "rooms": true
    }
}

JavaScript Example

const res = await fetch('/app/Customer.Welcome', { method: 'POST', headers: { Authorization: 'Bearer YOUR TOKEN' } });
console.log(await res.json());

Error Example

{
    "success": 0,
    "error": "customer_login_required"
}