This operation posts a message in a conversation as specified by the conversationId. You can retrieve the conversationId by listing the conversations for a contact or by listing all conversations in the organization. You can also send messages to a phone number, an email address or securely message a contact using a specific internal endpoint. The requestID
returned by this API may be used to match against the requestID
field of the conversationItem.created
webhook event to identify when the message is posted.
Posting an internal message containing a page for an organization member
To post a message with a page for an organization member, you'll first need to know the member's id. You can find the id of the organization member by listing all organization members. Once the member id is known, you can post a message to the conversation with internal=true
and an element of type=page
and value=<member-id>
in the list of body
elements being posted.
The body
parameter is a list of message elements. Each element can be of type text
or page
. The request can contain combinations of text
and page
elements to create internal messages with useful content while also notifying a set of members.
Posting to a Team or Note conversation
You can also use this API to post messages into a Team or Note conversations. For Note conversations, you will have to specify internal=true
since only internal messages can be posted in Note conversations.
NOTE: Message attachments are not yet supported in the API.