Parameter with header-body-footer , buttons – quick-replay,visit-website,phone-number

This document provides detailed information about the Marketing Template (marketing_x). It is designed for marketing purposes, allowing businesses to send customizable messages to users. The template supports placeholders for dynamic content, enabling personalized communication.

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

Components

This template consists of four primary components: Header, Body, Footer, and Buttons.

1. Header Component

• Type: HEADER
• Format: TEXT
• Text: Our {{1}} is on!
• Example Usage:
  • Example Header Text: Our Summer Sale is on!
  • Here, {{1}} is dynamically replaced with Summer Sale or any other promotional event.

2. Body Component

• Type: BODY
• Text: We are intraducing {{1}} new product about {{2}}
• Example Usage:
  • Example Body Text: We are introducing our new product about WhatsApp message app.
  • Here, {{1}} is dynamically replaced with our, and {{2}} is replaced with WhatsApp message app.

3. Footer Component

• Type: FOOTER
• Text: Thank you for choosing us!
• Purpose: This provides a polite closing message, enhancing customer engagement and gratitude.

4. Buttons Component

• Type: BUTTONS
• Buttons:
  • Type: QUICK_REPLY
  • Text: Unsubscribe from Promos
  • Purpose: Provides an interactive button allowing users to quickly opt out of promotional messages.
  • Type: URL
  • Text: Go to link
  • URL: https://app.pingtochat.com/
  • Purpose: Directs users to an external link for additional information or actions.
  • Type: PHONE_NUMBER
  • Text: Call
  • Phone Number: +91xxxxxxxxxx
  • Purpose: Allows users to directly call a specified phone number for further assistance.

Dynamic Placeholders

The template includes placeholders for dynamic content:

• {{1}} in Header: Represents the name of the promotional event (e.g., Summer Sale, Winter Discount).
• {{1}} in Body: Represents an introductory phrase (e.g., our, the latest).
• {{2}} in Body: Represents the product or service being introduced (e.g., WhatsApp message app).

Example Message Generation

Given the following placeholder values:

• {{1}} (Header) = Holiday Sale
• {{1}} (Body) = our
• {{2}} (Body) = new chat feature

The generated message will be:

Header: Our Holiday Sale is on!

Body: We are introducing our new product about new chat feature.

Footer: Thank you for choosing us!

Buttons:

• Unsubscribe from Promos
• Go to link (Redirects to https://app.pingtochat.com/)
• Call (Dials +91xxxxxxxxxx)

Sample Request

{
  "name": "marketing_x",
  "language": "en_US",
  "category": "MARKETING",
  "allow_category_change": true,
  "components": [
        {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Our {{1}} is on!",
        "example": {
            "header_text": [
            "Summer Sale"
            ]
        }
        },
        {
        "type": "BODY",
        "text": "We are intraducing  {{1}} new product about {{2}}",
        "example": {
            "body_text": [
            [
                "our","whatsapp message app"
            ]
            ]
        }
        },
        {
        "type": "FOOTER",
        "text": "Thank you for choosing us!"
        },
        {
        "type":"BUTTONS",
        "buttons": [
                {
                "type": "QUICK_REPLY",
                "text": "Unsubscribe from Promos"
                },
                {
                "type": "url",
                "text": "Go to link",
                "url": "https://app.pingtochat.com/"
                },
                {
                "type": "PHONE_NUMBER",
                "text": "Call",
                "phone_number": "91xxxxxxxxxx"
                }
            ]
        }
    ]
}

Success Response

Status Code: 201 APPROVED

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

Notes

• The template allows changes to the category since allow_category_change is set to true.
• Proper spelling and grammar should be maintained in the placeholders to ensure a professional message.
• Avoid hardcoding values and always use dynamic placeholders for flexibility.
• The Unsubscribe from Promos button helps provide an easy opt-out option for users, ensuring compliance with marketing regulations.
• The Go to link button enables users to navigate to external pages for more details or additional actions.
• The Call button provides direct contact with customer support or sales teams, improving customer engagement.