API Reference
  1. Viv Public API
  2. Caregivers

Create caregiver

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

Create a new caregiver record. For new hires coming through the application
process, use the Applicants API and the /applicants/{id}/hire endpoint instead.

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

Caregiver input for create/update operations

string

Caregiver's first name

string

Caregiver's last name

string

Primary phone number (will be normalized to digits only)

string

Email address (will be normalized to lowercase)

date

Date of birth (YYYY-MM-DD)

string
enum

Gender (only 'male' or 'female' accepted)

Allowed:
address
object

Standard address format used across the API (matches internal manualAddressSchema)

string

Geographic location ID

string
enum

Recruiting/employment status. Case-insensitive.

string
enum

Employment state for hired caregivers (active = currently working, inactive = temporarily unavailable). Only applicable when status is 'hired'. Case-insensitive.

Allowed:
string

External system identifier

date

Date of hire (YYYY-MM-DD)

date

Date of termination (YYYY-MM-DD)

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?