TAtalkdesk
HLS Providers

Cancel appointments on VA

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

delete/healthcare/cancel-appointments-va

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/healthcare/cancel-appointments-va
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: hls-appointment:write

Query parameters

interaction_idstring required
Example:abc

Required interaction Id

agent_idstring
Example:617bc5d698cec24b2e3c16eb

Talkdesk agent ID related to this interaction

reasonstring
Example:cancel appointment

Cancelled Appointment reason

commentstring

Cancelled Appointment comment

Example:comment
appointment_idstring

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

Example:a-55614

Response

OK

idstring

Cancelled Appointment identifier

provider_idstring

Cancelled Appointment provider identifier

provider_namestring

Cancelled Appointment provider name

service_type_idstring

Cancelled Appointment service type identifier

location_idstring

Cancelled Appointment location identifier

Changes

No recorded changes to this operation across all 2 revisions of this API.