Create template

Create template

Request

Create template request:

Headers

Create template headers:

Body

Create template body fields:

Structure object

Header object

Header example object

Body object

Body example object

Buttons object

Supported_apps object

Limited_time_offer object

Carousel object

The carousel component can be sent under either the carousel key or the carousel_cards key. Both are accepted and map to the same component.

Cards object

Example

Complete Create template examples. Each body below is a valid -d payload for the request above; send one of them instead of the General body.

General body

💾
curl -X POST "https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/template" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {{admin-token}}' \
-d '{
    "wba_id": "1234567899870",
    "name": "notificacion_de_pedido",
    "language": "es_MX",
    "category": "AUTHENTICATION|MARKETING|UTILITY",
    "structure":
    {
        "header":
        {
            "format": "TEXT|IMAGE|DOCUMENT|VIDEO|LOCATION|GIF",
            "text": "ORDER: {{1}}",
            "example":
            {
                "header_handle":
                [
                    "file-handle"
                ],
                "header_text":
                [
                    "header-example"
                ]
            }
        },
        "body":
        {
            "text": "Your order {{1}} is about to arrive",
            "example":
            {
                "body_text":
                    [
                        [  "123"]
                    ]
            }
        },
        "footer": "My company",
        "buttons":
        [
            {
                "type": "PHONE_NUMBER|URL|QUICK_REPLY|COPY_CODE|FLOW",
                "text": "phone-button-text|url-button-text",
                "url": "https://www.website.com/{{1}}",
                "phone_number": "+52(1) 555-1111",
                "example":
                [
                    "https://www.website.com/dynamic-url-example"
                ]
            }
        ]
    }
}'

Custom text-header body

A MARKETING template with a TEXT header, a body with parameters, a footer, and QUICK_REPLY + URL buttons.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_custom_text",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "header": {
            "format": "TEXT",
            "text": "Big sale, {{1}}!",
            "example": {
                "header_text": [
                    "Ana"
                ]
            }
        },
        "body": {
            "text": "Hi {{1}}, enjoy {{2}} off your next order this weekend only.",
            "example": {
                "body_text": [
                    [
                        "Ana",
                        "20%"
                    ]
                ]
            }
        },
        "footer": "My Company",
        "buttons": [
            {
                "type": "QUICK_REPLY",
                "text": "Stop promotions"
            },
            {
                "type": "URL",
                "text": "Shop now",
                "url": "https://www.website.com/{{1}}",
                "example": [
                    "https://www.website.com/sale"
                ]
            }
        ]
    }
}

Flows body

💾
{
    "name": "lead_cj_cm_dudas",
    "language": "es_MX",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "Connect with your customers on the right channel at the right time. SMS, RCS, WhatsApp, Messenger, Email, Voice, Chatbot, and much more."
        },
        "buttons":
        [
            {
                "type": "FLOW",
                "text": "Sign up",
                "flow_id": "1636507303762565",
                "navigate_screen": "CONTACT_INFO",
                "flow_action": "navigate"
            }
        ]
    },
    "wba_id": "1234567899870",
    "allowCategoryChange": false
}

Carousel body with media by URL

💾
{
    "wba_id": "1234567899870",
    "allowCategoryChange": false,
    "name": "ejemplo_plantilla_carrusel",
    "language": "es_MX",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "Give your customers the best experience on their favorite channels. Use code {{1}} to get {{2}} off when you sign up.",
            "example":
            {
                "body_text":
                [
                    [
                        "DESCUENTO2024",
                        "25%"
                    ]
                ]
            }
        },
        "carousel":
        {
            "cards":
            [
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "https://iili.io/HDQOyc7.jpg"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "Connect with your customers on the right channel at the right time. SMS, RCS..."
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Sign up",
                            "url": "https://www.conceptomovil.com/producto_broadcastermobile.html"
                        }
                    ]
                },
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "https://iili.io/HDQOyc7.jpg"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "Serve your customers with chatbots and agents through WhatsApp conversations"
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Sign up",
                            "url": "https://www.conceptomovil.com/producto_broadcasterbot.html"
                        }
                    ]
                }
            ]
        }
    }
}

Carousel body with media by ID

The header_handle value is the ID you get from Upload header media.

💾
{
    "wba_id": "1234567899870",
    "allowCategoryChange": false,
    "name": "coupon_code_fall2023_25off_02",
    "language": "en_US",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "Give your customers the best experience on their favorite channels. Use code {{1}} to get {{2}} off when you sign up.",
            "example":
            {
                "body_text":
                [
                    [
                        "Juan Pablo",
                        "25OFF"
                    ]
                ]
            }
        },
        "carousel":
        {
            "cards":
            [
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "4::aW1hZ2UvcG5n:ARZExampleHandle1:e:1771350704:1234567890:1234567890:ARZExample"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "Connect with your customers on the right channel at the right time. SMS, RCS..."
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Sign up",
                            "url": "https://www.conceptomovil.com/producto_broadcastermobile.html",
                            "example":
                            [
                                "https://www.conceptomovil.com/producto_broadcastermobile.html"
                            ]
                        }
                    ]
                },
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "4::aW1hZ2UvcG5n:ARZExampleHandle2:e:1771350704:1234567890:1234567890:ARZExample"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "Serve your customers with chatbots and agents through WhatsApp conversations"
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Sign up",
                            "url": "https://www.conceptomovil.com/producto_broadcasterbot.html",
                            "example":
                            [
                                "https://www.conceptomovil.com/producto_broadcasterbot.html"
                            ]
                        }
                    ]
                },
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "4::aW1hZ2UvcG5n:ARZExampleHandle3:e:1771350704:1234567890:1234567890:ARZExample"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "The smart platform for managing your promotional campaigns"
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Sign up",
                            "url": "https://www.conceptomovil.com/producto_cmmkt.html",
                            "example":
                            [
                                "https://www.conceptomovil.com/producto_cmmkt.html"
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

Media card carousel body (carousel_cards)

Up to 10 cards. All cards must use the same header format (IMAGE or VIDEO) and the same button list (count, types and order). Each card allows a maximum of 2 buttons of type PHONE_NUMBER, URL or QUICK_REPLY. This example uses the carousel_cards alias of the carousel component.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_media_carousel",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "body": {
            "text": "Hi {{1}}, check out this week's featured deals!",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "carousel_cards": {
            "cards": [
                {
                    "header": {
                        "format": "IMAGE",
                        "example": {
                            "header_handle": [
                                "https://www.website.com/card1.jpg"
                            ]
                        }
                    },
                    "body": {
                        "text": "Summer jacket, now {{1}} off.",
                        "example": {
                            "body_text": [
                                [
                                    "30%"
                                ]
                            ]
                        }
                    },
                    "buttons": [
                        {
                            "type": "QUICK_REPLY",
                            "text": "More info"
                        },
                        {
                            "type": "URL",
                            "text": "Buy now",
                            "url": "https://www.website.com/jacket"
                        }
                    ]
                },
                {
                    "header": {
                        "format": "IMAGE",
                        "example": {
                            "header_handle": [
                                "https://www.website.com/card2.jpg"
                            ]
                        }
                    },
                    "body": {
                        "text": "Running shoes, now {{1}} off.",
                        "example": {
                            "body_text": [
                                [
                                    "25%"
                                ]
                            ]
                        }
                    },
                    "buttons": [
                        {
                            "type": "QUICK_REPLY",
                            "text": "More info"
                        },
                        {
                            "type": "URL",
                            "text": "Buy now",
                            "url": "https://www.website.com/shoes"
                        }
                    ]
                }
            ]
        }
    }
}

Limited-time offer body

💾
{
    "wba_id": "1234567899870",
    "allowCategoryChange": false,
    "name": "coupon_code_fall2023_25off_02",
    "language": "en_US",
    "category": "MARKETING",
    "structure":
    {
        "header":
        {
            "format": "IMAGE",
            "example":
            {
                "header_handle":
                [
                    "https://iili.io/HDQOyc7.jpg"
                ]
            }
        },
        "limited_time_offer":
        {
            "text": "Ends soon!",
            "has_expiration": true
        },
        "body":
        {
            "text": "Today only, {{1}}! Use code {{2}} to get a big discount when you sign up!",
            "example":
            {
                "body_text":
                [
                    [
                        "Juan Pablo",
                        "25OFF"
                    ]
                ]
            }
        },
        "buttons":
        [
            {
                "type": "COPY_CODE",
                "example":
                [
                    "1234"
                ]
            },
            {
                "type": "URL",
                "text": "Sign up!",
                "url": "https://www.conceptomovil.com/producto_broadcasterdata.html"
            }
        ]
    }
}

Zero-tap authentication body

To implement zero-tap authentication in your Android app, see Meta's documentation.

💾
{
    "wba_id": "1234567899870",
    "allowCategoryChange": true,
    "name": "zero_tap_example",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "structure":
    {
        "body":
        {
            "add_security_recommendation": true
        },
        "footer_code_expiration_minutes": 5,
        "buttons":
        [
            {
                "type": "OTP",
                "otp_type": "zero_tap",
                "text": "Copy Code",
                "autofill_text": "Autofill",
                "zero_tap_terms_accepted": true,
                "supported_apps":
                [
                    {
                        "package_name": "com.example.luckyshrub",
                        "signature_hash": "K8a/AINcGX7"
                    }
                ]
            }
        ]
    }
}

Request contact info body

Asks WhatsApp users who have an active username to share their phone number.

💾
{
    "wba_id": "1234567899870",
    "name": "request_contact_template",
    "language": "es_MX",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "We'd like your contact details so we can keep you posted on what's new. If you want to receive updates and promotions, share your contact information with us."
        },
        "buttons":
        [
            {
                "type": "REQUEST_CONTACT_INFO"
            }
        ]
    }
}

Custom body with media header (IMAGE)

The endpoint downloads the header_handle URL and uploads it to Meta, replacing it with the returned media ID. VIDEO, DOCUMENT and GIF headers work the same way (GIF is sent as VIDEO when MM Lite is not applicable).

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_custom_image",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "header": {
            "format": "IMAGE",
            "example": {
                "header_handle": [
                    "https://www.website.com/promo-banner.jpg"
                ]
            }
        },
        "body": {
            "text": "Hi {{1}}, our new collection is here. Tap below to explore.",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "footer": "My Company",
        "buttons": [
            {
                "type": "URL",
                "text": "View collection",
                "url": "https://www.website.com/collection"
            }
        ]
    }
}

Coupon code body (COPY_CODE)

The COPY_CODE button copies the code in example[0] to the customer's clipboard when tapped.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_coupon_code",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "body": {
            "text": "Hi {{1}}, use the code below to get 25% off your next purchase.",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "footer": "Offer valid until stock lasts",
        "buttons": [
            {
                "type": "QUICK_REPLY",
                "text": "Stop promotions"
            },
            {
                "type": "COPY_CODE",
                "example": [
                    "SAVE25"
                ]
            }
        ]
    }
}

Location header body

A UTILITY template with a LOCATION header. The location pin is populated when the template message is sent.

💾
{
    "wba_id": "1234567899870",
    "name": "utility_order_delivery_update",
    "language": "en_US",
    "category": "UTILITY",
    "structure": {
        "header": {
            "format": "LOCATION"
        },
        "body": {
            "text": "Good news {{1}}! Your order #{{2}} is on its way to the location above. Thank you for your order!",
            "example": {
                "body_text": [
                    [
                        "Mark",
                        "566701"
                    ]
                ]
            }
        },
        "footer": "To stop receiving delivery updates, tap the button below.",
        "buttons": [
            {
                "type": "QUICK_REPLY",
                "text": "Stop Delivery Updates"
            }
        ]
    }
}

Copy-code authentication body

💾
{
    "wba_id": "1234567899870",
    "name": "authentication_code_copy_code_button",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "structure": {
        "body": {
            "add_security_recommendation": true
        },
        "footer_code_expiration_minutes": 10,
        "buttons": [
            {
                "type": "OTP",
                "otp_type": "copy_code",
                "text": "Copy Code"
            }
        ]
    }
}

One-tap authentication body

💾
{
    "wba_id": "1234567899870",
    "name": "authentication_code_autofill_button",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "structure": {
        "body": {
            "add_security_recommendation": true
        },
        "footer_code_expiration_minutes": 15,
        "buttons": [
            {
                "type": "OTP",
                "otp_type": "one_tap",
                "text": "Copy Code",
                "autofill_text": "Autofill",
                "supported_apps": [
                    {
                        "package_name": "com.example.luckyshrub",
                        "signature_hash": "K8a/AINcGX7"
                    }
                ]
            }
        ]
    }
}

Catalog button body

The CATALOG button opens the business catalog linked to the WABA.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_catalog_button",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "body": {
            "text": "Hi {{1}}, explore our full product catalog and find your next favorite item.",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "footer": "My Company",
        "buttons": [
            {
                "type": "CATALOG",
                "text": "View catalog"
            }
        ]
    }
}

Send location button body

The SEND_LOCATION button prompts the WhatsApp user to share their location.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_send_location_button",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "body": {
            "text": "Hi {{1}}, share your location so we can find the nearest store for you.",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "buttons": [
            {
                "type": "SEND_LOCATION"
            }
        ]
    }
}

Order details button body

The ORDER_DETAILS button starts an order and payment flow. See Payments Brazil templates.

💾
{
    "wba_id": "1234567899870",
    "name": "order_details_template",
    "language": "es_MX",
    "category": "UTILITY",
    "structure": {
        "body": {
            "text": "Review the details of your order and pay."
        },
        "buttons": [
            {
                "type": "ORDER_DETAILS",
                "text": "Review and pay"
            }
        ]
    }
}

Response

Create template response:

If the template is created successfully, the service responds with HTTP status code 201 and the template data.

Note: the response may include extra optional fields (for example message_send_ttl_seconds) when they were sent in the request.

💾
{
    "id": "572279198452421",
    "name": "ejemplo_respuesta",
    "language": "es_MX",
    "status": "PENDING",
    "namespace": "2d2354d2_54fd_123r_842f_2d5b215188fa",
    "wba_id": "1234567899870",
    "category": "MARKETING",
    "allowCategoryChange": true
}