Create a new Caregiver by Template name

post

https://organization/v1/users/caregivers/templates/{templateName}

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
_credentialType	string	false	What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP
_dateOfBirth	string	false	A person's date of birth A UTC date in the ISO-8601 format	2007-12-20
_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	false	An email address in the RFC-5322 specification	[email protected]
_employeeId	string	false
_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(*)
_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
Query Parameters:

Parameter	Type	Mandatory	Description	Example
includeReferencers	boolean	false	Optional query parameter that controls whether the response should include referencers metadata. When set to true, the response will contain an additional `_referencers` JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.). If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments. Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

This API requires PROTECTED_API permission(s).

Path Params

templateName

string

required

Query Params

includeReferencers

boolean

Optional query parameter that controls whether the response should include referencers metadata.
When set to true, the response will contain an additional _referencers JSON node with information about entities that reference this entity (e.g. referrer template, attribute, count, etc.).
If this query parameter is not provided, a default behavior will be applied. The default value is configurable and may differ between environments.
Note: Enabling referencers information may impact performance, as additional data needs to be resolved and returned.

Body Params

_name

object

required

_description

string

A description, can be up to 5000 characters long

_email

string

An email address in the RFC-5322 specification

_phone

string

A person's phone An E.164 formatted phone number

_locale

string

A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.

_gender

string

enum

A persons gender

Allowed:

_dateOfBirth

string

A person's date of birth A UTC date in the ISO-8601 format

_address

object

_mfa

object

_credentialType

string

enum

What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD

Allowed:

_employeeId

string

_degree

string

enum

An caregiver's name

_ownerOrganization

object

required

Headers

x-execution-mode

string

enum

Defaults to async

X-Execution-Mode — Optional header to control execution mode.

Use sync to make the API wait until all background operations complete before returning a response.

If omitted, the request is processed asynchronously (default).

Allowed:

Responses

401Code : TOKEN_NOT_VALID, Details: []

404Code : ORGANIZATION_NOT_FOUND, Details: [id] Code : TEMPLATE_NOT_FOUND_BY_NAME, Details: [templateName] Code : REFERENCE_CONFIGURATION_ENTITY_NOT_FOUND, Details: [attributeName, entityId]

409Code : EMAIL_ALREADY_EXIST, Details: [email] Code : USERNAME_ALREADY_EXIST, Details: [username, userId]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []