Skip to main content
Version: v3

Send a new message

POST 
/conversations/messages

Post the necessary fields for the API to send a new message.

Request​

Version stringrequired

API Version

Available optionsv3
application/json

Bodyrequired

    typestringrequired

    Type of message being sent

    Available optionsSMSEmailWhatsAppIGFBCustomLive_ChatInternalComment
    contactIdstringrequired

    ID of the contact receiving the message

    appointmentIdstring

    ID of the associated appointment

    attachmentsstring[]

    Array of attachment URLs

    emailFromstring

    Email address to send from

    emailCcstring[]

    Array of CC email addresses

    emailBccstring[]

    Array of BCC email addresses

    htmlstring

    HTML content of the message

    messagestring

    Text content of the message. For InternalComment type, use @username<userId>actualUserId</userId> format to mention team members. The mentioned user IDs must also be included in the mentions array.

    subjectstring

    Subject line for email messages

    replyMessageIdstring

    ID of message being replied to

    templateIdstring

    ID of message template

    threadIdstring

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

    scheduledTimestampnumber

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

    conversationProviderIdstring

    ID of conversation provider

    emailTostring

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

    emailReplyModestring

    Mode for email replies

    Available optionsreplyreply_all
    fromNumberstring

    Phone number used as the sender number for outbound messages

    toNumberstring

    Recipient phone number for outbound messages

    statusstringrequired

    Message status

    Available optionsdeliveredfailedpendingread
    mentionsstring[]

    Array of user IDs mentioned in the message. Required for InternalComment type. User IDs correspond to team members tagged with @username<userId>id</userId> format in the message text.

    userIdstring

    Use this field to specify the user who is making the internal comment when type is 'InternalComment'. If not provided, the comment will be attributed to the system or default user.

application/json

Created the message

Schema
    conversationIdstringrequired

    Conversation ID.

    emailMessageIdstring

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

    messageIdstringrequired

    This is the main Message ID

    messageIdsstring[]

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

    msgstring

    Additional response message when sending a workflow message