Conversations
Send Message by Channel
Conversations
Send Message by Channel
POST
/
conversation
/
message
/
{type}
/
{value}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
type
enum<string>
requiredType of conversation identifier. It can be "conversationId" for the conversation ID, "phone" for the phone number, or "email" for the email address.
Available options:
conversationId, phone, email value
string
requiredValue corresponding to the identifier type specified in "type".
Body
application/json
message
string
requiredContent of the message to be sent.
agentId
string
(Optional) Agent ID, in cuid format.
channel
enum<string>
(Optional) Channel used to send the message.
Available options:
website, dashboard, whatsapp, zapi, telegram, instagramDm attachments
object[]
(Optional) List of attachments to be sent.
visitorId
string
(Optional) Visitor ID, if applicable.
contactId
string
(Optional) Contact ID, if applicable.
Response
200 - application/json
success
boolean
message
object
Was this page helpful?