This operation creates a new conversation within an organization.
Note: Only secure conversation types can be created through this API endpoint.
A new conversation can be started with a single contact or a group of contacts. All contacts must be patients and either have a Spruce account or a pending secure invite.
Asynchronous Message Processing
If a message is included in the conversation creation request, the message will be posted asynchronously after the conversation is created. The API will immediately return the conversation details along with a postMessageRequestId
that can be used to track when the message is actually sent.
The postMessageRequestId
returned in the response can be matched against the requestID
field of the conversationItem.created
webhook event to identify when the message has been successfully posted to the conversation.