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

No parameter with header-text and body

Estimated reading: 2 minutes 71 views

Create a Template

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.

Request Body

{
  "name": "edit_c",
  "language": "en_US",
  "category": "MARKETING",
  "allow_category_change": true,
  "components": [
        {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Our summer sale is on!"
        },
        {
        "type": "BODY",
        "text": "Shop now  and use code CR7000 to get more offer"
        } 
    ]
}

Parameters

  • name (string, required) – The name of the template.
  • language (string, required) – Language code of the template (e.g., “en_US”).
  • category (string, required) – The category of the template (e.g., “MARKETING”).
  • allow_category_change (boolean, optional) – Determines whether the category can be changed.
  • components(array, required) – List of components in the template.
    • type (string, required) – Type of component (e.g., “HEADER”, “BODY”).
    • format (string, optional) – Format type for the HEADER component (e.g., “TEXT”).
    • text (string, required) – The actual text content of the template.

Success Response

Status Code: 201 APPROVED

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

Edit an Existing Template

Endpoint

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

Request Body

{
    "components": [
        {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Our summer sale is on in Urwallet!"
        },
        {
            "type": "BODY",
            "text": "We are introducing our new product in Urwallet!"
        }
    ]
}

Parameters

  • template_id (string, required) – The ID of the template to be updated.
  • components(array, required) – Updated list of components in the template.
    • type (string, required) – Type of component (e.g., “HEADER”, “BODY”).
    • format (string, optional) – Format type for the HEADER component (e.g., “TEXT”).
    • text (string, required) – The updated text content of the template.

Response

{
    "success": true,
    "id": "xxxxxx",
    "name": "edit_c",
    "category": "marketing"
}

Notes

  • The {{your_domain}} should be replaced with the actual domain.
  • The {{phone_number_id}}, {{key}}, and {{template_id}} should be replaced with the actual values.
  • Ensure that the request body is formatted correctly as JSON.
  • Only authorized users with a valid key can create or update templates.
  • Categories may be restricted based on platform policies.

Leave a Comment

Share this Doc

No parameter with header-text and body

Or copy link

CONTENTS