POST

AppointmentCoupon.Edit

Update an unused appointment coupon. Same fields as the dashboard Edit Coupon modal. Alias route: AppointmentCoupon.Update.

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

  • Updates the requested AppointmentCoupon record after validating permissions and input fields.

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.
  • Staff/org token required. Customer portal alias: Customer.Appointments.Coupon.Edit / Customer.Appointments.Coupon.Update.

Required Parameters

NameTypeSampleExplanation
coupon_id
post
int388Coupon id. Aliases: id, data_id.

Optional Parameters

NameTypeSampleWhat it gives
customer_id
post
int108545Customer id. Aliases: cust_id, coupon_cust.
coupon_code
post
string12345Coupon code.
appointment_type_id
post
int697Alias: coupon_appo_type_id.
insurance
post
int2Alias: coupon_insurance_company.
amount
post
number100Alias: coupon_amount.
left_amount
post
number50Alias: coupon_left_amount.
notes
post
stringupdated noteAlias: coupon_note.
coupon_date
post
date2026-02-17Coupon date Y-m-d. Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
order_id
post
int0Optional order id.

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\/AppointmentCoupon.Edit",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "coupon_id": "388",
        "coupon_code": "12345",
        "amount": "120",
        "left_amount": "60",
        "notes": "updated note"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/AppointmentCoupon.Edit",
    "url_domain": "https:\/\/{domain}\/app\/AppointmentCoupon.Edit"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Success",
    "coupon_id": 388,
    "data": {
        "id": 388,
        "coupon_code": "12345",
        "amount": "120"
    }
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ coupon_id: '388', amount: '120', left_amount: '60' });
const res = await fetch('/app/AppointmentCoupon.Edit', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());

Error Example

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