Enable automatic welcome message

Ice-breaker prompts (max 4)

Main message text

Header will be located above message text

Footer will be placed under message text

Action for open list

Up to 10 sections from which the client can choose.

Each section is object with fields:

title - Title of section, up to 24 symbols. Required if there are more then 1 section

rows - available options. Required

Each option is object with fields:

id - Unique id for option, up to 200 symbols. Required

title - Title of option, up to 24 symbols. Required

description - Description of option, up to 72 symbols

Example:

[{"title":"Section 1","rows":[{"id":"1","title":"Option 1","description":"Description 1"}]},{"title":"Section 2","rows":[{"id":"2","title":"Option 2","description":"Description 2"}]}]

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Main message text

Footer will be placed under message text

Up to 3 sections inclusive.

Each section is an object with a fields:

type - always "reply" Required

reply – reply button objects Required

Each button response is an object with fields:

id - a unique identifier of the button, up to 200 characters. Required

title — Button title, up to 20 characters. Required

Example:

"sections": [{"type": "reply","reply": {"id ": "1","title": "1 Button's Title"}},{"type": "reply", "reply": {"id": "2", "title": "2 Button's Title"}}]

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Message text, UTF-8 or UTF-16 string with emoji 🍏. Can be used with mentionedPhones, example: this text for @556123122026

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Flow message body text

Flow header (string or text header object)

Footer text

Published Flow ID

Flow token generated by the business

CTA button text

Flow action type

Required for flowAction=navigate (screen is required). Ignored for data_exchange. If data is provided, it must be a non-empty object.

Flow message version (default "3")

Flow mode (draft or published). If omitted, provider default applies

Shortcut for flowActionPayload.data (optional)

Shortcut for flowActionPayload.screen (optional)

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

One emoji to add/update or empty string to remove

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

File source when not using mediaId:

• HTTP/HTTPS URL (https://...)
• Base64 data URI, e.g. data:image/jpeg;base64,/9j/...
• File in form-data input field

Required together with filename, unless mediaId + mediaType are used.

File name with extension, e.g. 1.jpg or hello.xlsx. Required with body; not required when sending by mediaId.

Text under the file. When sending an image сan be used with mentionedPhones, example: this image for @556123122026

Numeric WABA media id from /uploadMedia. Alternative to body/filename. Requires mediaType. Do not combine with body.

Required when using mediaId. Not used for stickers — use /sendSticker.

If true and the media is audio, send as a native WhatsApp voice note. Prefer OGG/OPUS. Works with URL/base64 or mediaId + mediaType=audio.

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Numeric WABA media id from /uploadMedia (webp). Mutually exclusive with link.

Public HTTPS URL to a webp sticker. Mutually exclusive with mediaId.

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Main message text

CTA button label

Button URL (must use https://)

Optional footer text

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Message text, UTF-8 or UTF-16 string with emoji 🍏. Can be used with mentionedPhones, example: this text for @556123122026

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Latitude of the location. Example: 45.018337

Longitude of the location. Example: -73.968285

Address of the location. Only displayed if name is present. Example: 9766 Valley View St., New York, NY 10024

Name of the location. Example: Facebook HQ

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Array containing contact objects.

Contact object parameters:

name - full contact name. Required. Object with properties:

• formatted_name - Full name, as it normally appears. Example: Lord Adam John Smith Junior. You have to use at least one additional parameter (first_name, last_name, middle_name, suffix, prefix)

• first_name - First name. Example: Adam

• last_name - Last name. Example: Smith

• middle_name - Middle name. Example: John

• suffix - Name suffix. Example: Junior

• prefix - Name prefix. Example: Lord

birthday - YYYY-MM-DD formatted string. Example: 2012-08-18

addresses - array containing address objects with parameters:

• street - Street number and name. Example: 1 Hacker Way

• city - City name. Example: Menlo Park

• state - State abbreviation. Example: CA

• zip - ZIP code. Example: 94025

• country - Full country name. Example: United States

• country_code - Two-letter country abbreviation. Example: us

• type - Standard Values: HOME, WORK. Example: HOME

emails - array containing email objects with parameters:

• email - Email address. Example: test@fb.com

• type - Standard Values: HOME, WORK. Example: WORK

org - object containing parameters:

• company - Name of the contact's company. Example: WhatsApp

• department - Name of the contact's department. Example: Design

• title - Contact's business title. Example: Manager

phones - array containing phone objects with parameters:

• phone - Automatically populated with the wa_id value as a formatted phone number. Example: +1 (940) 555-1234

• type - Standard Values: CELL, MAIN, IPHONE, HOME, WORK. Example: HOME

• wa_id - WhatsApp ID. Example: 19405551234

urls - array containing url objects with parameters:

• url - URL. Example: https://www.facebook.com

• type - Standard Values: HOME, WORK. Example: WORK

Example: [{"addresses":[{"city":"Menlo Park","country":"United States","country_code":"us","state":"CA","street":"1 Hacker Way","type":"HOME","zip":"94025"},{"city":"Menlo Park","country":"United States","country_code":"us","state":"CA","street":"200 Jefferson Dr","type":"WORK","zip":"94025"}],"birthday":"2012-08-18","emails":[{"email":"test@fb.com","type":"WORK"},{"email":"test@whatsapp.com","type":"WORK"}],"name":{"first_name":"John","formatted_name":"John Smith","last_name":"Smith"},"org":{"company":"WhatsApp","department":"Design","title":"Manager"},"phones":[{"phone":"+1 (940) 555-1234","type":"HOME"},{"phone":"+1 (650) 555-1234","type":"WORK","wa_id":"16505551234"}],"urls":[{"url":"https://www.facebook.com","type":"WORK"}]}]

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Text shown above the carousel. Optional. If omitted and params include a body component, the body will be taken from params.

Required. Template-like structure (same as sendTemplate params). Must include a CAROUSEL component and its cards.

Structure:

• params[] item with type CAROUSEL and cards (2..10)
  • cards[] item:
    • card_index: number
    • components[] items:
      • header: parameters[0] with type image/video/product
        • image: {"image": {"link": "https://..."}}
        • video: {"video": {"link": "https://..."}}
        • product: {"product": {"catalog_id": "...", "product_retailer_id": "..."}}
      • body: parameters[] with {"type": "text", "text": "..."}
      • button: sub_type url or quick_reply
        • url: parameters {"text": "Button", "url": "https://..."}
        • quick_reply: parameters[] of {"id": "...", "text": "..."}
• Optional params[] item with type body to set the text above the carousel.

Quoted message ID (Cloud API)

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.

Address form country (IN or SG). Defaults to IN.

Optional prefilled address fields

Optional saved addresses

Optional validation errors

Recipient phone (India E.164 digits, no +). Use phone or chatId.

Recipient chatId (e.g. phone@c.us). Use phone or chatId.

Approved Utility template name that includes an ORDER_DETAILS button

Template namespace from the channel / template list

Template language

Extra template components (HEADER / BODY / etc.). If an order_details button is missing, the API appends one from order / referenceId / currency / paymentSettings.

Unique order / payment reference id (maps to reference_id)

Currency code for India payments

Optional payment settings (UPI / payment gateway / payment link). Forwarded as payment_settings on the order_details action.

Order payload for the ORDER_DETAILS button. Typical fields: status, items[], subtotal, tax, shipping, discount. Amount objects use { "offset": 100, "value": } (e.g. value 50000 with offset 100 = ₹500.00).

Message ID. Example: 0XzkmGNn4prUAQlzsHApGNRXQ0U

Alias for messageId (either messageId or msgId is required).

Group name

New group name

New group description

Can be found by method /templates

Name of template

Object, containing fields "policy" and "code".

policy - now "deterministic" is only available option;

code - one of supported language codes

Array of localizable parameters to be substituted into the template. Each parameter is object contains the following field:

type - section of parameters - header, body, footer, button

parameters - variables for section.

Each variable is an object that can contain the following fields:

type - can be text, currency, date_time, image, document, video or product

video- id (mediaId)

document

• id (mediaId)

• filename(optional)

image - object with field link (image url)

product - object with catalog_id and product_retailer_id (for catalog carousel product cards)

currency - object containing parameters currency_code and amount_1000.

• currency_code - Currency code as defined in ISO 4217.

• amount_1000 - Amount multiplied by 1000.

• fallback_value - Default text if localization fails.

date_time - If the date_time object is used, further definition of the date and time is required.

• component - The time is assembled from components (i.e., day of the week, month, hour, etc.) The time specified will be the same, regardless of the time zone the client is in.

• unix_epoch - The time to be displayed is dependent on the time zone the client is in.

• fallback_value - Default text if localization fails.

button - if button has parameter

• sub_type (url/quick_reply/copy_code)

• parameters (array to fill button variable)

• index - button position.

coupon_code - for COPY_CODE buttons use parameters with type coupon_code and coupon_code value.

limited_time_offer - for limited-time offer templates:

• parameters: [{type: limited_time_offer, limited_time_offer: {expiration_time_ms: }}]

• If limited_time_offer.has_expiration is true, include limited_time_offer parameters and a copy code button first; URL button required.

cards - filled in if you need to send the Carousel template

• card_index - card number

• components - array of card data

  type -  header, body, footer, button 
  
  parameters - variables for the section. 
  
  sub_type - subtype for buttons 
  
  index - button number
  

The number of parameters passed must match the number of parameters in the template

Force Marketing Messages API (POST marketing_messages). If omitted: auto for MARKETING category when the channel has mm_lite_enabled and mm_lite_available service settings.

Sets message_activity_sharing on the WABA payload (click tracking webhooks). Requires the MM Lite path. Ignored on Cloud API fallback.

Template message TTL in seconds (message_send_ttl_seconds). MARKETING via MM Lite: 43200–2592000. AUTHENTICATION: 30–900. UTILITY: 30–43200. AUTH/UTILITY also accept -1 (30-day custom TTL).

Required if phone and bsuid are not set

Chat ID from the message list. Examples: 12020721369@c.us, RU.1504711984690866@lid, username@username, or 120363046942338209@g.us (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: phone@c.us, bsuid@lid, username@username, or group@g.us.