/

Add a new guest

post
Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body
idstringOptional

Unique identifier for the patient

Example: 12345
firstNamestringOptional

First name of the patient

Example: John
lastNamestringOptional

Last name of the patient

Example: Doe
middleNamestringOptional

Middle name of the patient

Example: Michael
birthDateone ofOptional

Birth date of the patient

Example: 1990-01-01
string · dateOptional
or
string · date-timeOptional
timeZonestringOptional

Time zone of the patient

Example: GMT+1
genderstring · enumOptional

Gender of the patient

Example: MalePossible values:
emailstringOptional

Email address of the patient

Example: [email protected]
mobileNumberstringOptional

Mobile number of the patient

Example: +1234567890
authenticationIdstringOptional

Authentication ID of the patient

Example: auth123
addressLine1stringOptional

Address line 1 of the patient

Example: 123 Main St
addressLine2stringOptional

Address line 2 of the patient

Example: Apt 4B
citystringOptional

City of the patient

Example: New York
statestringOptional

State of the patient

Example: NY
zipCodestringOptional

Zip code of the patient

Example: 10001
countrystringOptional

Country of the patient

Example: USA
secondaryEmailstring · emailOptional

Secondary email address of the patient

Example: [email protected]
secondaryPhonestringOptional

Secondary phone number of the patient

Example: +0987654321
regionNamestringOptional

Region name of the patient

Example: North
territorystringOptional

Territory of the patient

Example: East
mrnstringOptional

Medical record number of the patient

Example: MRN12345
departmentstringOptional

Department of the patient

Example: Cardiology
isDependantbooleanOptional

Is the patient a dependant

isPrimarybooleanOptional

Is the patient primary

Example: true
isPatientbooleanOptional
attributesanyOptional

Attributes of the patient

lastLoginAtone ofOptional

Last login date of the patient

Example: 2023-01-01
string · dateOptional
or
string · date-timeOptional
activebooleanOptional

Is the patient active

Example: true
profilePicCloudIdstringOptional

Profile picture cloud ID of the patient

Example: cloud123
organizationIdnumberOptional

Organization ID of the patient

Example: 1
guardianIdnumberOptional

Guardian ID of the patient

Example: 1
populationTagIdsinteger[]Optional

Population tags of the patient

relationshipTypestring · enumOptional

Relationship type of the patient

Example: SELFPossible values:
relatedPatientIdnumberOptional

Related Patient ID

Example: 1
Responses
200Success
application/json
post
/api/guests/
200Success