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

This operation schedules the Spruce data of the embedded patient behind a contact for deletion after a 30 day grace period and revokes every token issued for the patient. The contact must be one this organization embedded. The organization's conversation with the patient is marked inactive until the deletion is cancelled or completes.
Calling this operation again while the deletion is pending succeeds and answers the same scheduledDeletionTime, so a request can be retried after a lost response.

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

The id of the embedded patient 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.

Responses

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