API Reference

Cancel a Waitlist registration

put
https://api.vcita.biz/platform/v1/scheduling/waitlist/cancel

Overview

Cancel a waitlist registration. Available for Client tokens.

The underlying controller inherits from Api::ClientApi::V1::BaseController, which only accepts client authentication.

Required Fields

  • Always required: business_uid, event_instance_uid, client_uid, and matter_uid
  • client_uid must be explicitly provided in the request body for the authorization check to pass. The controller extracts it from the request parameters, not from the token.
  • matter_uid is used to look up the specific waitlist entry to cancel.

Note

Staff can cancel waitlist entries using the business API endpoint PUT /business/scheduling/v1/waitlist/cancel which supports staff tokens and the waitlist_uid parameter.

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

Business UID. Required.

string
required

Client UID. Required. Must be explicitly provided in the request body for the authorization check (authorize_action(:cancel_waitlist)) to pass. The controller reads this from params[:client_uid], not from the token.

string
required

Event instance UID. Required. Identifies which event's waitlist to cancel from.

string
required

Matter/conversation UID. Required. Used to look up the specific waitlist entry to cancel.

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