API Reference
  1. Viv Public API
  2. Caregivers

Set caregiver status to TERMINATED

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

Permanently terminate a caregiver's employment. This action cannot be
undone through the API. Terminated caregivers cannot be assigned to visits.

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

Reason for termination (optional)

date

Effective termination date. Defaults to current date if not provided.

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?