API Reference
  1. Viv Public API
  2. Caregivers

Set caregiver status to INACTIVE

post
https://{apiHost}/api/v2/public/caregivers//status/inactive

Temporarily deactivate a hired caregiver. Inactive caregivers cannot be
assigned to visits but can be reactivated later.

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

Unique caregiver identifier

Body Params
string

ID of a predefined deactivation reason (get from /config/caregiver-deactivation-reasons). Optional.

string

Additional notes

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?