Update Patient

Update Patient

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

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_additionalPhonestringfalseAn E.164 formatted phone number+12345678901
_address.address1stringfalseAn address11 Main St.
_address.address2stringfalseAn address's specificsEntry B, Apartment 1
_address.citystringfalseA cityBoston
_address.countryCodestringfalseA 2-letter country code defined in ISO-3166US
_address.statestringfalseA stateMassachusetts
_address.zipCodestringfalseA zipcode02101
_caregiver.idstringfalseA UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_dateOfBirthstringfalseA UTC date in the ISO-8601 formatThu Dec 20 00:00:00 UTC 2007
_descriptionstringfalseA description, can be up to 5000 characters longLorem Ipsum
_emailstringfalseAn email address in the RFC-5322 specification[email protected]
_genderstringfalseA persons gender Values:MALE,FEMALE,UNDISCLOSEDFEMALE
_localestringfalseA java locale supported by the java runtime environmenten_US
_mfa.enabledbooleanfalseIs mfa enabled in login
_mfa.expirationInMinutesintegerfalseMfa expiration in minutes5
_name.firstNamestringfalseA person's first nameJohn
_name.lastNamestringfalseA person's last nameSmith
_nationalIdstringfalseA person's national ID123456789
_ownerOrganization.idstringfalseA UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_phonestringfalseAn E.164 formatted phone number+12345678901

Path Parameters:

ParameterTypeMandatoryDescriptionExample
idstringtruePatient ID that needs to be updated3fa85f64-5717-4562-b3fc-2c963f66afa6

This API requires PROTECTED_API permission(s).

Language
Authentication
Bearer
JWT
Click Try It! to start a request and see the response here!