API Reference

Invite patient to Spruce

post
https://api.sprucehealth.com/v1/contacts//invite

This operation sends an invite to a patient contact:

  • If the contact is invited for the first time, a new secure conversation will be created,
  • If the contact is already invited, the invite will be re-sent to the same secure conversation,
  • If the contact is already on Spruce, an error will be returned.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the contact to invite.

Body Params
string

The message to send to the invitee.

string
required

The id of the phone number or email to send the invite to.

string
required

Organization's internal secure endpoint that will be used to send the invite.

Responses

Updated 7 months ago

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

Updated 7 months ago