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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Details

NameTypeDescription
successbooleanIndicates whether the cancellation is successful.
is_charge_appliedbooleanIndicates whether a cancellation or no-show charge is applied.
errorobjectObject that contains error message and error code details. For more information, refer to the error Object table.

error Object

codemessage
602Cannot access.
502payments are added to invoice, delete payments and retry.
438cannot access.
602User does not have access.
400The request is invalid.
428Request invoices are Invalid.
502invoice doesn't have any appointments.
Path Params
string
required

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

Query Params
string

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json