Create a template

POST

/api/v1/whats_app_templates

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/json

Example

{
  "whats_app_template": {
    "template_name": "Test Template",
    "language": "en",
    "category": "MARKETING",
    "purpose": "general",
    "whats_app_business_account_id": "waba_ext_123",
    "components_attributes": [
      {
        "component_type": "body",
        "data_type": "text",
        "value": "Hello {{subscriber.name | fallback: \"there\" | example: \"John\"}}, this is a test message.",
        "index": 0
      },
      {
        "component_type": "header",
        "data_type": "image",
        "index": 0
      },
      {
        "component_type": "footer",
        "data_type": "text",
        "value": "Reply STOP to unsubscribe",
        "index": 1
      },
      {
        "component_type": "buttons",
        "sub_type": "url",
        "name": "Visit Website",
        "value": "https://example.com",
        "index": 2
      }
    ]
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/whats_app_templates' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "whats_app_template": {
    "template_name": "Test Template",
    "language": "en",
    "category": "MARKETING",
    "purpose": "general",
    "whats_app_business_account_id": "waba_ext_123",
    "components_attributes": [
      {
        "component_type": "body",
        "data_type": "text",
        "value": "Hello {{subscriber.name | fallback: \"there\" | example: \"John\"}}, this is a test message.",
        "index": 0
      },
      {
        "component_type": "header",
        "data_type": "image",
        "index": 0
      },
      {
        "component_type": "footer",
        "data_type": "text",
        "value": "Reply STOP to unsubscribe",
        "index": 1
      },
      {
        "component_type": "buttons",
        "sub_type": "url",
        "name": "Visit Website",
        "value": "https://example.com",
        "index": 2
      }
    ]
  }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": "wat_abcd1234",
    "template_name": "WhatsApp Template",
    "name": "WhatsApp Template",
    "system_name": "whatsapp_template",
    "language": "en",
    "category": "MARKETING",
    "folder": "",
    "status": "approved",
    "reason": null,
    "purpose": "general",
    "whats_app_business_account_id": 1,
    "user": {
        "id": 1,
        "name": "John Doe",
        "email": "johndoe@example.com",
        "phone_number": "+919988776655",
        "time_zone": "Kolkata"
    },
    "components": [
        {
            "type": "HEADER",
            "format": "IMAGE",
            "example": {
                "header_handle": [
                    "https://storage.googleapis.com/..."
                ]
            }
        },
        {
            "type": "BODY",
            "text": "Hello {{1}}, use code {{2}} for a discount!",
            "example": {
                "body_text": [
                    [
                        "Jane",
                        "PEACH20"
                    ]
                ]
            }
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "URL",
                    "text": "Shop Now",
                    "url": "https://..."
                },
                {
                    "type": "QUICK_REPLY",
                    "text": "Stop Promos"
                }
            ]
        }
    ],
    "placeholders": [
        "1",
        "2"
    ],
    "liquid_values": [
        "subscriber.first_name",
        "campaign.coupon_code"
    ],
    "created_at": "2026-02-06T06:53:28.426Z",
    "updated_at": "2026-02-06T06:56:21.069Z"
}

Modified at 2026-04-21 12:14:00

List all templates

Update template