API Reference
  1. Viv Public API
  2. Visits

Cancel visit

post
https://{apiHost}/api/v2/public/visits//cancel

Cancel a scheduled or confirmed visit. Locked visits cannot be cancelled.

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

Unique visit identifier

Body Params
string

ID of a predefined cancellation reason. Use GET /config/cancellation-reasons to get valid options.

string

Free-text cancellation reason (optional, cancellationReasonId is preferred)

boolean
Defaults to false

Whether the caregiver arrived before cancellation

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?