post https://example.com/organization/v1/users/caregivers/templates/
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:
Parameter | Type | Mandatory | Description | Example |
---|---|---|---|---|
<customAttribute1> | <customAttribute1Type> | false | Regular custom attribute 1 value | |
<customAttributeN> | <customAttributeNType> | false | Regular custom attribute N value | |
_address | object | false | ||
_address.address1 | string | false | An address | 11 Main St. |
_address.address2 | string | false | An address's specifics | Entry B, Apartment 1 |
_address.city | string | false | A city | Boston |
_address.countryCode | string | true(*) | A 2-letter country code defined in ISO-3166 | US |
_address.state | string | false | A state | Massachusetts |
_address.zipCode | string | false | A zipcode | 02101 |
_dateOfBirth | string | false | A person's date of birth A UTC date in the ISO-8601 format | Thu Dec 20 00:00:00 UTC 2007 |
_degree | string | false | An 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,OTHER | PHYSICIAN_ASSISTANT |
_description | string | false | A description, can be up to 5000 characters long | Lorem Ipsum |
_email | string | true | An email address in the RFC-5322 specification | [email protected] |
_employeeId | string | true | ||
_gender | string | false | A persons gender Values:MALE,FEMALE,UNDISCLOSED | FEMALE |
_locale | string | false | A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase. | en-us |
_mfa | object | false | ||
_mfa.enabled | boolean | true(*) | MFA login enabled or disabled | |
_mfa.expirationInMinutes | integer | false | MFA expiration time in minutes | |
_name | object | true | ||
_name.firstName | string | true(*) | A person's first name | John |
_name.lastName | string | true(*) | A person's last name | Smith |
_ownerOrganization | object | true | ||
_ownerOrganization.id | string | true(*) | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
_phone | string | false | A person's phone An E.164 formatted phone number | +12345678901 |
Path Parameters:
Parameter | Type | Mandatory | Description | Example |
---|---|---|---|---|
templateName | string | true | null |
This API requires PROTECTED_API permission(s).