User GuideAPI Reference
ProductUse CasesResource CenterFAQAbout UsBook a DemoSign Up - It's Free
API Reference

Create a new Caregiver by Template name

Create a new Caregiver by Template name

Email confirmation landing page is required as a header

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_addressobjectfalse
_address.address1stringfalseAn address11 Main St.
_address.address2stringfalseAn address's specificsEntry B, Apartment 1
_address.citystringfalseA cityBoston
_address.countryCodestringtrue(*)A 2-letter country code defined in ISO-3166US
_address.statestringfalseA stateMassachusetts
_address.zipCodestringfalseA zipcode02101
_dateOfBirthstringfalseA person's date of birth A UTC date in the ISO-8601 formatThu Dec 20 00:00:00 UTC 2007
_degreestringfalseAn caregiver's name Values:MEDICAL_DOCTOR,DOCTOR_OF_OSTEOPATHY,PHYSICIAN_ASSISTANT,REGISTERED_NURSE,CLINICAL_NURSE_SPECIALISTS,NURSE_PRACTITIONER,LICENSED_PRACTICAL_NURSE,MEDICAL_ASSISTANT,NO_DEGREE,OTHERPHYSICIAN_ASSISTANT
_descriptionstringfalseA description, can be up to 5000 characters longLorem Ipsum
_emailstringtrueAn email address in the RFC-5322 specification[email protected]
_employeeIdstringtrue
_genderstringfalseA persons gender Values:MALE,FEMALE,UNDISCLOSEDFEMALE
_localestringfalseA person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.en-us
_mfaobjectfalse
_mfa.enabledbooleantrue(*)MFA login enabled or disabled
_mfa.expirationInMinutesintegerfalseMFA expiration time in minutes
_nameobjecttrue
_name.firstNamestringtrue(*)A person's first nameJohn
_name.lastNamestringtrue(*)A person's last nameSmith
_ownerOrganizationobjecttrue
_ownerOrganization.idstringtrue(*)A UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_phonestringfalseA person's phone An E.164 formatted phone number+12345678901

Path Parameters:

ParameterTypeMandatoryDescriptionExample
templateNamestringtruenull

This API requires PROTECTED_API permission(s).

Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!