API Reference

Cancel a Booking [Business]

put
https://api.vcita.biz/business/scheduling/v1/bookings/cancel

Overview

Cancel an existing booking. Available for Staff and App tokens.

Batch Operations

Supports batch operations by providing an array of booking IDs (max 50).

Parameters

  • cancel_payment: Set to true to cancel any associated payment
  • issue_refund: Set to true to issue a refund for the cancelled booking
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Booking (appointment/event) UID. Can be a single string or array of strings for batch operations (max 50).

string
required

Business UID

string

Event instance UID. Provide this when cancelling an event registration rather than an appointment.

string

Optional message to include with the cancellation notification.

boolean

Set to true to cancel any associated payment.

boolean

Set to true to issue a refund for the cancelled booking.

Responses

Updated 2 months ago

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

Updated 2 months ago