API de Gerenciamento do WhatsApp Business
Voltar para Português (Brasil)
Este documento foi atualizado.
A tradução para Português (Brasil) não foi concluída ainda.
Atualização em inglês: 14 de nov
Atualização em Português (Brasil): 22 de ago

We are making changes to the WhatsApp Business Platform pricing model. See Pricing Updates on the WhatsApp Business Platform.

Catalog Templates

This document explains how to create catalog templates. See Sell Products & Services to learn more about product catalogs and ways to showcase your products.

Catalog templates are marketing templates that allow you to showcase your product catalog entirely within WhatsApp. Catalog templates display a product thumbnail header image of your choice and custom body text, along with a fixed text header and fixed text sub-header.

When a customer taps the View catalog button in a catalog template message, your product catalog appears within WhatsApp.

Requirements

You must have inventory uploaded to Meta in an ecommerce catalog connected to your WhatsApp Business Account.

Request Syntax

Use the WhatsApp Business Account > Message Templates endpoint to create a catalog template. Once your template is approved, you can use Cloud API to send it in a template message.

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/messages_templates

Post Body

{
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "<BODY_TEXT>",
      "example": {
        "body_text": [
          [
            "<EXAMPLE_BODY_TEXT>"
          ]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "<FOOTER_TEXT>"
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "CATALOG",
          "text": "View catalog"
        }
      ]
    }
  ]
}

Properties

PlaceholderDescriptionSample Value

<BODY_TEXT>

String

Required.


Template body text. Variables are supported.


Maximum 1024 characters.

Now shop for your favourite products right here on WhatsApp! Get Rs {{1}} off on all orders above {{2}}Rs! Valid for your first {{3}} orders placed on WhatsApp!

<EXAMPLE_BODY_TEXT>

String (of an array of strings)

Required if body text uses variables.


Sample strings to replace variable placeholders in <BODY_TEXT> string.


Maximum 1024 characters.

100

<FOOTER_TEXT>

String

Optional.


Template footer text. Variables are supported.


Maximum 60 characters.

Best grocery deals on WhatsApp!

<LANGUAGE>

String

Required.


Template language and locale code.

en_US

<NAME>

String

Required.


Template name.


Maximum 512 characters.

intro_catalog_offer

Example Request

curl 'https://graph.facebook.com/v17.0/102290129340398/message_templates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "name": "intro_catalog_offer",
  "language": "en_US",
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "Now shop for your favourite products right here on WhatsApp! Get Rs {{1}} off on all orders above {{2}}Rs! Valid for your first {{3}} orders placed on WhatsApp!",
      "example": {
        "body_text": [
          [
            "100",
            "400",
            "3"
          ]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "Best grocery deals on WhatsApp!"
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "CATALOG",
          "text": "View catalog"
        }
      ]
    }
  ]
}'

Example Response

{
  "id": "546151681022936",
  "status": "PENDING",
  "category": "MARKETING"
}

Sending Templates

Once your catalog template is approved, you can use the Cloud API to send it in a catalog template message.

See Also