Cancel appointments on VA

Cancel the appointment that is selected on the interaction using interactionId.

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

Scope

hls-appointment:write

Query Params
string
required
length between 1 and 2147483647

Required interaction Id

string
length between 1 and 2147483647

Talkdesk agent ID related to this interaction

string
length between 1 and 2147483647

Cancelled Appointment reason

string
length between 1 and 2147483647

Cancelled Appointment comment

string
length between 1 and 2147483647

Cancelled Appointment Id, if appointment id is provided, it cancels that appointment. Otherwise, the appointment is canceled based on the current interaction.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json