Catalog

​

Request

​

Field types

• to: string (required)
• type: string = interactive (required)
• interactive: object (required)
• interactive.type: string = catalog_message (required)
• interactive.body: object (required)
• interactive.body.text: string (required)
• interactive.footer: object (optional)
• interactive.footer.text: string (optional)
• interactive.action: object (required)
• interactive.action.name: string = catalog_message (required)
• interactive.action.parameters: object (optional)
• interactive.action.parameters.thumbnail_product_retailer_id: string (optional)
• tags: array of strings (optional)
• metadata: object | string (optional)

​

Field behavior and limits

• interactive.body.text is required, max 1024 characters.
• interactive.footer.text is optional, max 60 characters.
• interactive.action.name must be catalog_message.
• interactive.action.parameters.thumbnail_product_retailer_id is optional. If provided, WhatsApp uses the image of that product as the message header thumbnail. If omitted, WhatsApp uses the image of the first product in the catalog.
• A catalog must be uploaded to Meta Commerce Manager and connected to the WhatsApp Business account before this message type can be used.
• Cannot be sent as a notification — only inside an existing conversation.

{
  "to": "+573001112233",
  "type": "interactive",
  "interactive": {
    "type": "catalog_message",
    "body": {
      "text": "¡Hola! Gracias por tu interés. Ordenar es fácil: visitá nuestro catálogo y agregá productos al carrito."
    },
    "footer": {
      "text": "Las mejores ofertas por WhatsApp"
    },
    "action": {
      "name": "catalog_message",
      "parameters": {
        "thumbnail_product_retailer_id": "SKU-featured"
      }
    }
  }
}