API Reference
  1. Viv Public API
  2. Visits

Update visit

put
https://{apiHost}/api/v2/public/visits/

Update a visit. Locked visits cannot be modified and will return 403 Forbidden.

Visits are locked when:

  • Included in finalized payroll
  • Submitted for billing/invoicing
  • Submitted to EVV aggregator (e.g., HHAeXchange)
  • Manually locked by administrator
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique visit identifier

Body Params

Visit input for create/update operations

string

Client ID (required for create)

string | null

Caregiver ID (optional, can be assigned later)

string

Geographic location ID

string

Booking type name (will be normalized)

string

Booking type ID

date-time

Scheduled start time (ISO 8601)

date-time

Scheduled end time (ISO 8601)

string

IANA timezone identifier

string
enum
Defaults to Current

Which client address to use for the visit. "Primary" uses the client's primary address; "Current" uses their current address.

Allowed:
string | null

Link to recurrence pattern (visit series)

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?