Pingtochat Docs

Pingtochat Docs

Did You Know?

You can create any type of product documentation with Docy

leafleafleafDocy banner shape 01Docy banner shape 02Man illustrationFlower illustration

Parameter with header and body

Estimated reading: 2 minutes 67 views

This document provides detailed information about the Marketing Template (marketing_t). 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_t
  • Language: en_US (English – United States)
  • Category: MARKETING
  • Allow Category Change: Yes

Components

This template consists of two primary components: Header and Body.

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.

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.

Example request

{
  "name": "marketing_t",
  "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"
            ]
            ]
        }
        }
    ]
}

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.

Leave a Comment

Share this Doc

Parameter with header and body

Or copy link

CONTENTS