POST

AppointmentCoupon.Apply

Apply one or more appointment coupon ids and return amount / left_amount totals (same as dashboard Apply on the coupon list). Works with staff Login and Customer.Login tokens (customer tokens are scoped to their own coupons).

Permissions

User must be logged in with a valid bearer token.
Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

Runs the AppointmentCoupon.Apply 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

Customer.Login tokens are allow-listed for this read/apply route. Other coupon write APIs stay staff-only.
Customer portal alias: Customer.Appointments.ApplyCoupon.

Required Parameters

Name	Type	Sample	Explanation
`coupon_ids` post	array\|string	`388,389`	One or more coupon ids. Aliases: coupon_id, data_id, id.

Optional Parameters

No optional body parameters are defined for this function.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/AppointmentCoupon.Apply",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "coupon_ids": [
            "388"
        ]
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/AppointmentCoupon.Apply",
    "url_domain": "https:\/\/{domain}\/app\/AppointmentCoupon.Apply"
}

Endpoint

POST /app/AppointmentCoupon.Apply
POST https://{user}.bull36.com/app/AppointmentCoupon.Apply
POST https://{domain}/app/AppointmentCoupon.Apply

Sample Output

{
    "success": 1,
    "message": "Success",
    "amount": 100,
    "left_amount": 50,
    "coupon_ids": {
        "388": {
            "amount": "100",
            "left_amount": "50"
        }
    }
}

JavaScript Example

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

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

Error Example

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