Skip to Content
API access is available to organizations with a signed BAA. Request API access →
API referenceUpdate a patient

Update a patient

PATCH/patients/{patientId}

Updates the fields you send and leaves the rest unchanged.

Credentials
API key, or an OAuth access token
Scope
patients.write

Run in Postman: import the collection, set api_key, and find this request in its folder.

Path parameters

patientIdUUIDRequired

ID of the patient.

Query parameters

org_idUUID

The organization the call acts on, from List organizations. Required when an account API key reaches more than one organization; an organization key or a key limited to one organization can leave it out.

Body parameters

Only the fields you send change. Send null to clear a field.

first_namestring

First name.

last_namestring

Last name.

date_of_birthdate or null

Date of birth.

phonestring or null

Mobile number.

emailstring or null

Email address.

mrnstring or null

The patient’s ID in your system.

Any other field returns 422 unknown_field. See Unknown fields are rejected.

Returns

Returns 200 OK with the Patient object.

Errors

Failed requests return application/problem+json problem details. The errors specific to this endpoint:

StatusCodeMeaning
400invalid_requestThe request is malformed, such as invalid JSON.
400org_id_requiredThe key reaches more than one organization: pass org_id.
401invalid_tokenThe API key is missing or malformed, or isn’t a BloomText key.
401key_revokedThe API key was revoked.
401key_expiredThe API key’s expiry has passed.
403insufficient_scopeThe key doesn’t have the scope this endpoint needs.
403org_not_reachableThe key can’t reach the organization in org_id.
404not_foundThe resource doesn’t exist, or isn’t visible to this credential.
422validation_failedA field failed validation. See field_errors.
429rate_limitedToo many requests. Retry after Retry-After seconds.
Last updated on