Skip to main content
POST
/
conversations
/
messages
Send a new message
curl --request POST \
  --url https://services.leadconnectorhq.com/conversations/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "type": "Email",
  "contactId": "abc123def456",
  "appointmentId": "appt123",
  "attachments": [
    "https://storage.com/file1.pdf",
    "https://storage.com/file2.jpg"
  ],
  "emailFrom": "sender@company.com",
  "emailCc": [
    "cc1@company.com",
    "cc2@company.com"
  ],
  "emailBcc": [
    "bcc1@company.com",
    "bcc2@company.com"
  ],
  "html": "<p>Hello World</p>",
  "message": "Hello, how can I help you today?",
  "subject": "Important Update",
  "replyMessageId": "msg123",
  "templateId": "template123",
  "threadId": "thread123",
  "scheduledTimestamp": 1669287863,
  "conversationProviderId": "provider123",
  "emailTo": "recipient@company.com",
  "emailReplyMode": "reply_all",
  "fromNumber": "+1499499299",
  "toNumber": "+1439499299"
}
'
{
  "conversationId": "ABC12h2F6uBrIkfXYazb",
  "messageId": "t22c6DQcTDf3MjRhwf77",
  "emailMessageId": "rnGyqh2F6uBrIkfhFo9A",
  "messageIds": [
    "<string>"
  ],
  "msg": "Message queued successfully."
}

Authorizations

​
Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-04-15

Body

application/json
​
type
enum<string>
required

Type of message being sent

Available options:
SMS,
Email,
WhatsApp,
IG,
FB,
Custom,
Live_Chat
Example:

"Email"

​
contactId
string
required

ID of the contact receiving the message

Example:

"abc123def456"

​
appointmentId
string

ID of the associated appointment

Example:

"appt123"

​
attachments
string[]

Array of attachment URLs

Example:
[
  "https://storage.com/file1.pdf",
  "https://storage.com/file2.jpg"
]
​
emailFrom
string

Email address to send from

Example:

"sender@company.com"

​
emailCc
string[]

Array of CC email addresses

Example:
["cc1@company.com", "cc2@company.com"]
​
emailBcc
string[]

Array of BCC email addresses

Example:
["bcc1@company.com", "bcc2@company.com"]
​
html
string

HTML content of the message

Example:

"<p>Hello World</p>"

​
message
string

Text content of the message

Example:

"Hello, how can I help you today?"

​
subject
string

Subject line for email messages

Example:

"Important Update"

​
replyMessageId
string

ID of message being replied to

Example:

"msg123"

​
templateId
string

ID of message template

Example:

"template123"

​
threadId
string

ID of message thread. For email messages, this is the message ID that contains multiple email messages in the thread

Example:

"thread123"

​
scheduledTimestamp
number

UTC Timestamp (in seconds) at which the message should be scheduled

Example:

1669287863

​
conversationProviderId
string

ID of conversation provider

Example:

"provider123"

​
emailTo
string

Email address to send to, if different from contact's primary email. This should be a valid email address associated with the contact.

Example:

"recipient@company.com"

​
emailReplyMode
enum<string>

Mode for email replies

Available options:
reply,
reply_all
Example:

"reply_all"

​
fromNumber
string

Phone number used as the sender number for outbound messages

Example:

"+1499499299"

​
toNumber
string

Recipient phone number for outbound messages

Example:

"+1439499299"

Response

Created the message

​
conversationId
string
required

Conversation ID.

Example:

"ABC12h2F6uBrIkfXYazb"

​
messageId
string
required

This is the main Message ID

Example:

"t22c6DQcTDf3MjRhwf77"

​
emailMessageId
string

This contains the email message id (only for Email type). Use this ID to send inbound replies to Hoop to create a threaded email.

Example:

"rnGyqh2F6uBrIkfhFo9A"

​
messageIds
string[]

When sending via the GMB channel, we will be returning list of messageIds instead of single messageId.

​
msg
string

Additional response message when sending a workflow message

Example:

"Message queued successfully."

Last modified on March 4, 2026