POST /conversations/messages

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

Servers

Request headers

Name Type Required Description
Version String Yes

API Version

Valid values:

  • "2021-04-15"
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Authorization String Yes

Access Token

Request body fields

Name Type Required Description
appointmentId String No
emailBcc[] Array No
emailFrom String No
conversationProviderId String No
subject String No
emailCc[] Array No
contactId String Yes
html String No
replyMessageId String No

Specify the emailId on which the reply needs to go out

emailTo String No

emailTo field is used when you want to send the email to a different email address than the contact's primary email.

templateId String No
attachments[] Array No
scheduledTimestamp Number No

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

message String No
type String Yes

Valid values:

  • "WhatsApp"
  • "IG"
  • "FB"
  • "Custom"
  • "Live_Chat"
  • "Email"
  • "GMB"
  • "SMS"
emailReplyMode String No

Valid values:

  • "reply_all"
  • "reply"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.