PUT
/
v1
/
patient
/
update
/
{patient_id}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

patient_id
string
required

Body

application/json
address
string | null
addressLineTwo
string | null
addressValid
boolean | null
allergies
string[] | null
city
string | null
country
string | null
dateOfBirth
string | null
email
string | null
externalUserId
string | null
familyHistory
string[] | null
firstName
string | null
gender
enum<string> | null
Available options:
MALE,
FEMALE,
OTHER,
PREFER_NOT_TO_SAY
lastName
string | null
medicalHistory
string[] | null
medications
string[] | null
meta
object | null
optedOutOfSms
boolean | null
phoneNumber
string | null
prescriptions
string[] | null
state
string | null
type
string | null
updatedDate
string
zipCode
string | null

Response

200 - application/json
createdDate
string
required

The date and time when the user was created.

firstName
string
required

The user's first name.

id
string
required

The unique identifier for the user.

type
string
required

The type of user.

address
string | null

The user's primary address.

addressLineTwo
string | null

Additional address information.

addressValid
boolean | null

Whether the user's address is valid.

allergies
string[] | null

List of patient's allergies.

city
string | null

The city of the user's address.

country
string | null

The country of the user's address.

dateOfBirth
string | null

The date of birth of the patient.

email
string | null

The user's email address.

externalUserId
string | null

The user's external identifier if available.

familyHistory
string[] | null

List of patient's family medical history.

lastName
string | null

The user's last name.

medicalHistory
string[] | null

List of patient's medical history.

medications
string[] | null

List of patient's medications.

meta
object | null

Any additional metadata about the user relevant to your system.

optedOutOfSms
boolean
default:
false

Indicates whether the patient has opted out of receiving SMS messages.

phoneNumber
string | null

The user's phone number.

prescriptions
string[] | null

List of patient's prescriptions.

state
string | null

The state of the user's address.

zipCode
string | null

The postal code of the user's address.