Embed a patient contact

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. See the Spruce Embedded Secure Messaging Overview for how it works.

This operation creates the embedded patient identity behind a patient contact and mints the token an embedding application presents on the embed host to act as that patient. The contact must be a patient that has neither a Spruce account nor a pending invite.
The token belongs to the device named by the required S-Device-ID header. Calling this operation again for the same device replaces that device's token; a patient may hold a live token on up to three devices, and minting for a fourth revokes the oldest. Send the same device id as S-Device-ID on every embed host request.

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

The id of the patient contact to embed.

Body Params

The practice-side settings for embedding a patient contact.

string
required

The organization's internal endpoint (Spruce Link) that owns the secure conversation with the embedded patient. Its default teammates and tags apply to the conversation and the contact.

Headers
string

A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long.

string
required

The embedding application's identifier for the device the patient token is minted for, up to 64 characters. Reuse it for that device so a new token replaces the device's old one instead of counting as another 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