Parameter with body buttons – quick-replay

This document provides detailed information about the Utility Templates used for communication purposes. These templates allow businesses to send structured messages to users for transactional or informational purposes

Endpoint

http://{{your_domain}}/api/v1.0/{{phone_number_id}}/{{key}}/message_templates

• {{your_domain}}: Your domain URL where the API is hosted.
• {{phone_number_id}}: The unique identifier of the phone number used for sending messages.
• {{key}}: Your API key for authentication.How to create key

Request Headers

• Authorization: Bearer token for authentication.
• Content-Type: Should be set to application/json.

Template Information

• Name: utility_aj
• Language: en_US (English – United States)
• Category: UTILITY
• Allow Category Change: Yes

Components

The utility_aj template consists of a Body and a Buttons component.

• Body:
  • Type: BODY
  • Text: "Item no {{1}} is confirmed!"
  • Example: "Item no 12CR007 is confirmed!"
  • Purpose: Serves as a confirmation notification for an item, order, or transaction with a dynamic item number.
• Buttons:
  • Type: BUTTONS
  • Buttons:
    • Type: QUICK_REPLY
    • Text: "Unsubscribe from Promos"
    • Purpose: Allows the recipient to quickly opt out of promotional messages.

Example Message Generation

Body: "Item no 12CR007 is confirmed!"
Buttons:

• "Unsubscribe from Promos"

Sample Request

{
  "name": "utility_aj",
  "language": "en_US",
  "category": "UTILITY",
  "allow_category_change": true,
  "components": [
        {
        "type": "BODY",
        "text": "Item no {{1}} is confirmed!",
        "example": {
            "body_text": [
            [
                "12CR007"
            ]
            ]
        }
        },
        {
        "type":"BUTTONS",
        "buttons": [
                {
                "type": "QUICK_REPLY",
                "text": "Unsubscribe from Promos"
                }
            ]
        }
    ]
}

Success Response

Status Code: 201 APPROVED

{
    "id": "xxxxxx",
    "status": "APPROVED",
    "category": "MARKETING"
}

Notes

• The template allows changes to the category since allow_category_change is set to true.
• It is designed for transactional confirmation messages with a simple opt-out feature.
• The Quick Reply Button enables users to opt out of promotional messages easily.
• There is no Footer or Header in this template, keeping it minimal and focused.