Post a message as the 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 posts a message from the patient into the conversation and answers with the posted item, the way the patient app does. At least one of text or attachments is required, and each attachment names media the patient uploaded through this API. Send an S-Idempotency-Key header to make a retry safe; a second request with the same key is refused.

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

The id of the conversation to post to

Body Params

A message to post as the patient. At least one of text or attachments is required.

attachments
array of objects
length ≤ 5

Media to attach, uploaded through this API by the patient. At most 5.

attachments
string

The plain text of the message. At most 5000 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.

string

A key the application chooses for one write, such as a UUID, so a retry of the same request is not applied twice. A second request with the same key, path and method within a day is refused with 422.

Responses

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