Parameter with header and body

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_x
• Language: en_US (English – United States)
• Category: UTILITY
• Allow Category Change: Yes

Components

The utility_x template consists of a Header and a Body component.

• Header:
  • Type: HEADER
  • Format: TEXT
  • Text: Hi confirmation from {{1}}!
  • Example: "Hi confirmation from P2C!"
  • Purpose: Provides a personalized greeting that includes a dynamic value (e.g., company name or sender).
• 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.

Example Message Generation

Header: "Hi confirmation from P2C!"
Body: "Item no 12CR007 is confirmed!"

Sample Request

{
  "name": "utility_x",
  "language": "en_US",
  "category": "UTILITY",
  "allow_category_change": true,
  "components": [
        {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Hi confirmation from {{1}}!",
        "example": {
            "header_text": [
            "P2C"
            ]
        }
        },
        {
        "type": "BODY",
        "text": "Item no {{1}} is confirmed!",
        "example": {
            "body_text": [
            [
                "12CR007"
            ]
            ]
        }
        }
    ]
}

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 utility purposes, such as order confirmations, service updates, or other transactional messages.
• The Header is dynamic, allowing customization of the sender name or company.
• The Body is also dynamic, enabling personalization of item numbers for better clarity.
• The message format supports variable placeholders, making it adaptable for multiple use cases.