Update the embedded patient

Requires Spruce Embedded Secure Messaging, a paid add-on. This endpoint is part of Spruce Embedded Secure Messaging, which is not included with standard Public API access. Contact Spruce Support at [email protected] to learn more.

This operation updates the patient's name on the patient's own Spruce record. Fields that are absent keep their value. The practice's contact record for the patient is not changed. After each successful update, the practice is told through an internal note in its copy of each one-to-one conversation with the patient; the note is not visible to the patient and is posted even when no value changed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The fields of the patient to change. Fields that are absent keep their value.

string

The patient's family name. It cannot be cleared. At most 250 characters.

string

The patient's given name. It cannot be cleared. At most 250 characters.

Headers
string

The device id returned beside the token when it was minted. Recommended on every request; it is recorded with the request but the token, not the header, names the device.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json