API Reference
  1. Viv Public API
  2. EVV

Update approved time

put
https://{apiHost}/api/v2/public/visits//evv/approved-time

Manually adjust the approved start/end times for a visit.

Change Reason Requirements:

  • When the enterprise partner has requireEvvChangeReason enabled and the visit
    start time is in the past, an editReason must be provided.
  • If the selected change reason has requiresMemo: true configured, the memo field
    within the editReason object is required.

Error Codes:

  • EVV_CHANGE_REASON_REQUIRED - Returned when change reason is required but not provided
  • EVV_CHANGE_REASON_MEMO_REQUIRED - Returned when memo is required but not provided or empty
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique visit identifier

Body Params
date-time

Approved start time

date-time

Approved end time

string

Reason for manual adjustment (deprecated, use editReason instead)

editReason
object

EVV change reason for the modification. Required when ALL of these conditions are met:

  1. The enterprise partner has requireEvvChangeReason enabled
  2. The visit start time is in the past
  3. The request modifies EVV-related fields (approved start/end times)

The server validates whether the changes actually require a reason by comparing
the submitted values against the existing booking data. If approved times have
not actually changed, no edit reason is required even if one is configured.

Get available EVV change reasons from /config/attributes?type=evvChangeReason.

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?