POST

AppointmentCoupon.Delete

Delete an appointment coupon row. Same action as the dashboard trash icon on unused coupons. Alias route: AppointmentCoupon.Remove.

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

  • Removes the requested AppointmentCoupon record when the user has permission.

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

  • Staff/org token required. Customer portal alias: Customer.Appointments.Coupon.Delete / Customer.Appointments.Coupon.Remove.

Required Parameters

NameTypeSampleExplanation
coupon_id
post
int388Coupon id. Aliases: id, data_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.Delete",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "coupon_id": "388"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/AppointmentCoupon.Delete",
    "url_domain": "https:\/\/{domain}\/app\/AppointmentCoupon.Delete"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Success",
    "coupon_id": 388
}

JavaScript Example

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

Error Example

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