API Reference
  1. Viv Public API
  2. Caregivers

Update caregiver document metadata

put
https://{apiHost}/api/v2/public/caregivers//documents/

Update an existing document metadata record. All fields are optional —
only fields included in the body are updated. Sending an empty body
is allowed and is a no-op (the controller does not require any
specific field).

About type: when type is included in the update payload it is
validated against the geo's configured caregiver document types
(case-sensitive exact match) plus the "Not provided" fallback.
Invalid types return 400 INVALID_DOCUMENT_TYPE. When type is
omitted, the existing value is preserved and no type validation
runs.

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

Unique caregiver identifier

string
required

The unique identifier of the document

Body Params
string

Document name

string

Document type label (tenant-configured per geo, plus the
"Not provided" fallback). Validated only when present.

string

Document description

string

Document status

string | null
^\d{2}/\d{2}/\d{4}$

Document expiry date in MM/DD/YYYY format

string | null
^\d{2}/\d{2}/\d{4}$

Document effective date in MM/DD/YYYY format

boolean

Whether the document is visible

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?