Sign in
provider
user

Update Patient

put/user/patient/{id}

Path parameters

idstring required

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

firstNamestring nullable
lastNamestring nullable
externalIdstring nullable
emailstring nullable
phoneNumberstring nullable
addressstring nullable
addressLineTwostring nullable
citystring nullable
statestring nullable
zipCodestring nullable
countrystring nullable
addressValidboolean nullable
metaobject nullable
primaryLocationIdstring nullable
dateOfBirthstring date nullable
allergiesstring[] nullable
familyHistorystring[] nullable
medicalHistorystring[] nullable
prescriptionsstring[] nullable
genderstring nullable
goalWeightnumber nullable
patientSource'SELF_SCHEDULING' | 'CALL' | 'TEXT' | 'MANUALLY_CREATED' | 'UPLOADED_FROM_FILE' | 'FORM' | 'SEED_DATA' | 'DEMO' | 'EXTERNAL_INTEGRATION' | 'OTHER'
surchargeDisabledboolean nullable
creditBalanceinteger nullable
preferredProviderIdstring nullable

Response

Successful Response

idstring required

The unique identifier for the user.

firstNamestring nullable

The user's first name.

lastNamestring nullable

The user's last name.

phoneNumberstring nullable

The user's phone number.

emailstring nullable

The user's email address.

type'PROVIDER' | 'PATIENT' | 'ASSISTANT' required
locationIdstring nullable

The location of the user.

externalIdstring nullable

The user's external identifier if available.

addressstring nullable

The user's primary address.

addressLineTwostring nullable

Additional address information.

citystring nullable

The city of the user's address.

statestring nullable

The state of the user's address.

zipCodestring nullable

The postal code of the user's address.

countrystring nullable

The country of the user's address.

createdDatestring date-time required

The date and time when the user was created.

addressValidboolean nullable

Whether the user's address is valid.

metaobject nullable

Any additional metadata about the user relevant to your system.

isArchivedboolean nullable

Whether the user is archived.

primaryLocationIdstring nullable

The primary location of the user.

genderstring nullable

The gender of the patient.

dateOfBirthstring date nullable

The date of birth of the patient.

patientMedicationsstring[] nullable

List of patient's self-reported medications.

onSchedulingBlacklistboolean nullable

Whether the patient is on the scheduling blacklist.

surchargeDisabledboolean nullable

Whether surcharges are disabled for this patient.

creditBalanceinteger nullable

Patient's credit balance in cents.

preferredProviderIdstring nullable

The preferred provider ID for this patient.

Changes

No recorded changes to this endpoint across all 1 revision of this API.