API Reference

Cancel a Booking [Alpha]

post
https://api.vcita.biz/platform/v1/scheduling/bookings/cancel

Overview

Cancel booking Available for Staff, App, Directory, and Client tokens.

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 obtained from:

  • GET /platform/v1/scheduling/bookings (requires Client token)
  • GET /platform/v1/scheduling/appointments (returns id field which is the booking_id)
  • Response from POST /platform/v1/scheduling/bookings (returns data.booking.id)
string
required

Business uid

string

Event instance uid. Required only for cancelling event registrations (not appointments).

Response

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