Customer.Appointments.Coupon.Get

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.Appointments.Coupon.Get 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.
• Requires Customer.Login token. Coupon must belong to JWT c_id; customer_id is never accepted from the body.

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

Endpoint

POST /app/Customer.Appointments.Coupon.Get
POST https://{user}.bull36.com/app/Customer.Appointments.Coupon.Get
POST https://{domain}/app/Customer.Appointments.Coupon.Get

Sample Output

{
    "success": 1,
    "message": "Success",
    "data": {
        "id": 388,
        "coupon_code": "12345",
        "appointment_type_id": 697,
        "amount": "100",
        "left_amount": "50",
        "status_label": "unused",
        "can_edit": true,
        "can_delete": true
    }
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('coupon_id', '388');

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

Error Example

{
    "success": 0,
    "message": "Coupon not found"
}