conversation_message_create_payload

contentstringrequired

The content of the message

Example: Hello, how can I help you?

message_typestring

The type of the message

Possible values: [outgoing, incoming]

Example: outgoing

privateboolean

Flag to identify if it is a private note

Example: false

content_typestring

Content type of the message

Possible values: [text, input_email, cards, input_select, form, article]

Example: text

content_attributesobject

Attributes based on the content type

Example: {}

campaign_idinteger

The campaign id to which the message belongs

Example: 1

template_params object

WhatsApp template parameters for sending structured messages

namestringrequired

Name of the WhatsApp template (must be approved in WhatsApp Business Manager)

Example: purchase_receipt

categorystringrequired

Category of the template

Possible values: [UTILITY, MARKETING, SHIPPING_UPDATE, TICKET_UPDATE, ISSUE_RESOLUTION]

Example: UTILITY

languagestringrequired

Language code of the template (BCP 47 format)

Example: en_US

processed_params objectrequired

Processed template parameters organized by component type

body object

Body component parameters with variable placeholders

property name*string

header object

Header component parameters for media templates

media_urlstring<uri>

Publicly accessible URL for IMAGE, VIDEO, or DOCUMENT headers

Example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf

media_typestring

Type of media for the header

Possible values: [image, video, document]

Example: document

buttons object[]

Button component parameters for interactive templates

Array [

typestring

Type of button parameter

Possible values: [url, copy_code]

parameterstring

Dynamic parameter value for the button

Example: SSFSDFSD

]

conversation_message_create_payload

{
  "content": "Hello, how can I help you?",
  "message_type": "outgoing",
  "private": false,
  "content_type": "text",
  "content_attributes": {},
  "campaign_id": 1,
  "template_params": {
    "name": "purchase_receipt",
    "category": "UTILITY",
    "language": "en_US",
    "processed_params": {
      "body": {
        "1": "Visa",
        "2": "Nike",
        "3": "Bill"
      },
      "header": {
        "media_url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
        "media_type": "document"
      },
      "buttons": [
        {
          "type": "url",
          "parameter": "SSFSDFSD"
        }
      ]
    }
  }
}