Sample Template Message

POST

https://rest.qikberry.ai/v1/whatsapp/messages

Template Messages

Templates support different components such as Header, Body, Footer, and Buttons, allowing businesses to send rich and interactive messages for various use cases like order updates, promotions, appointment reminders, and notifications.

A template message can include:

Header – Text, Image, Video, Document, or Location

Body – Main message content with optional variables

Footer – Additional information

Buttons – Quick Reply, CTA URL, Phone Number, or Copy Code

Note: Template messages must be created and approved before they can be sent to customers.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

The request was successfully accepted for processing. The response returns a confirmation message along with the unique message ID and the recipient's WhatsApp number.

Bodyapplication/json

🟠401Unauthorized

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://rest.qikberry.ai/v1/whatsapp/messages' \
--header 'x-phone-number: <WA_ID>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "to": "+91XXXXXXXXXX",
    "type": "template",
    "template": {
        "name": "invoice_offer_template",
        "language": "en",
        "components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "document",
                        "document": {
                            "link": "https://example.com/documents/invoice.pdf",
                            "filename": "Invoice_12345.pdf"
                        }
                    }
                ]
            },
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "Guru"
                    },
                    {
                        "type": "text",
                        "text": "#INV12345"
                    },
                    {
                        "type": "text",
                        "text": "₹2,499"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "url",
                "index": "0",
                "parameters": [
                    {
                        "type": "text",
                        "text": "INV12345"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "copy_code",
                "index": "1",
                "parameters": [
                    {
                        "type": "coupon_code",
                        "coupon_code": "SAVE20"
                    }
                ]
            }
        ]
    }
}'

Response Example

200 - Success

{
    "message": "1 numbers accepted",
    "data": [
        {
            "messageId": "<MESSAGE_ID>",
            "mobile": "<USER_PHONE_NUMBER>"
        }
    ]
}

Modified at 2026-08-06 06:21:09

Media card carousel templates

URL button

Sample Template Message

Template Messages#

Request

Responses

Template Messages