Update Caregiver

patch

https://organization/v1/users/caregivers/{id}

Update Caregiver

Performs partial update, if a field is specified in the request it will be updated

(*)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 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	Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_mfa	object	false
_mfa.enabled	boolean	false	Is mfa enabled in login
_mfa.expirationInMinutes	integer	false	Mfa expiration in minutes	5
_name	object	false
_name.firstName	string	true(*)	A person's first name	John
_name.lastName	string	true(*)	A person's last name	Smith
_ownerOrganization	object	false
_ownerOrganization.id	string	true(*)
_phone	string	false	An E.164 formatted phone number	+12345678901
Path Parameters:

Parameter	Type	Mandatory	Description	Example
id	string	true	Caregiver ID that needs to be updated	3fa85f64-5717-4562-b3fc-2c963f66afa6
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

uuid

required

Caregiver ID that needs to be updated

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

_description

string

A description, can be up to 5000 characters long

_email

string

An email address in the RFC-5322 specification

_phone

string

An E.164 formatted phone number

_locale

string

Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.

_gender

string

enum

A persons gender

Allowed:

_dateOfBirth

string

A UTC date in the ISO-8601 format

_address

object

_mfa

object

_employeeId

string

_degree

string

enum

An caregiver's name

_ownerOrganization

object

Responses

Parameter	Type	Description	Example
<customAttribute1>	<customAttribute1Type>	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	Regular custom attribute N value
_address	object
_address.address1	string	An address	11 Main St.
_address.address2	string	An address's specifics	Entry B, Apartment 1
_address.city	string	A city	Boston
_address.countryCode	string	A 2-letter country code defined in ISO-3166	US
_address.state	string	A state	Massachusetts
_address.zipCode	string	A zipcode	02101
_caption	string
_creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_credentialType	string	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	A person's date of birth A UTC date in the ISO-8601 format	2007-12-20
_degree	string	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	A description, can be up to 5000 characters long	Lorem Ipsum
_email	string	An email address in the RFC-5322 specification	[email protected]
_employeeId	string
_enabled	string	Is the user enabled Values:DISABLED,ENABLED	ENABLED
_gender	string	A persons gender Values:MALE,FEMALE,UNDISCLOSED	FEMALE
_id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_invitationAccepted	boolean	Has invitation been accepted
_lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_locale	string	A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_mfa	object
_mfa.enabled	boolean	MFA login enabled or disabled
_mfa.expirationInMinutes	integer	MFA expiration time in minutes
_name	object
_name.firstName	string	A person's first name	John
_name.lastName	string	A person's last name	Smith
_ownerOrganization	object
_ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.name	string	The caption of the referenced entity
_ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
_ownerOrganization.template	object
_ownerOrganization.template.displayName	string	The display name of the template
_ownerOrganization.template.id	string	The id of the template
_ownerOrganization.template.name	string	The name of the template
_ownerOrganization.template.parentTemplate	object
_ownerOrganization.template.parentTemplate.displayName	string
_ownerOrganization.template.parentTemplate.id	string
_ownerOrganization.template.parentTemplate.name	string
_ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.templateName	string	The name of the referenced entity template
_phone	string	A person's phone An E.164 formatted phone number	+12345678901
_referencers	object	An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1)
_template	object
_template.displayName	string	The display name of the template
_template.id	string	The id of the template
_template.name	string	The name of the template
_template.parentTemplate	object
_template.parentTemplate.displayName	string
_template.parentTemplate.id	string
_template.parentTemplate.name	string

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Code : TOKEN_NOT_VALID, Details: []

404Code : USER_NOT_FOUND, Details: [id] Code : ORGANIZATION_NOT_FOUND, Details: [id] 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: []