v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Cancel a service booking

Use this API to cancel a service booking.

You must specify the invoice_id parameter, and this API will cancel all the appointments and purchases associated with the invoice.

This API also allows guests to cancel service bookings of family members. Provided, there is a relationship defined in Zenoti and only the host can cancel the service booking of family members.

put/v1/invoices/{invoice_id}/cancel

Path parameters

invoice_idstring required

Mandatory Unique 32-character of the invoice that contains the appointments that you want to cancel.

Query parameters

commentsstring

Optional Reasons for the cancellation. Note: Comments will be Mandatory or Optional depending on your configuration.

Response

200

successboolean
is_charge_appliedboolean

Example response

{
  "success": true
}