{"info":{"_postman_id":"7adb3bb7-7dac-4214-a8dc-005e6dc82c15","name":"baat.ai - WhatsApp Template","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"44300938","collectionId":"7adb3bb7-7dac-4214-a8dc-005e6dc82c15","publishedId":"2sB2iwGFCk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-22T06:48:24.000Z"},"item":[{"name":"Send WhatsApp Template Message","id":"6b02b841-2d8f-40a8-9925-c98b6945913f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://apis.baat.ai/v1/whatsapp/messages","description":"

This endpoint enables you to send a WhatsApp template message through baat.ai, which internally connects to the Meta Cloud API.

Request Header Parameters

X-API-KEY (string): Required header used for authenticating API access. You must include a valid API key for baat.ai.

Request Body Parameters

phone_number (string): The phone number of the recipient. It should have the country code like '91' for India, followed by the mobile number (10-digit number for Indian mobile numbers).
\n
contact_name (string): The contact name of the recipient.
\n
message (object): The message content including body, header, footer, button, language code, and template name.
\n
- body_params (array of strings): An array of strings used to populate the placeholders in the template body (e.g., {{1}}, {{2}}).
  \n
- header_params (array of strings): An array of strings used for header content. This may include text (e.g., codes), or media URLs for image, video, or document headers.
  \n
- button_params (array of strings): An array of strings containing dynamic values used in button URLs or call actions.
  \n
- language_code (string): The language code for the message, such as en, hi, or en_US.
  \n
- template_name (string): The name of the approved WhatsApp template to be sent.
  \n
\n
template_id (string): The ID of the template, mapped internally to baat.ai’s cache and Meta’s registry.
\n
channel_id (number): The ID of the channel configured within baat.ai. Each baat.ai account can have multiple WhatsApp numbers (WABA phone numbers) associated with it, each represented as a distinct channel. This ID determines which WhatsApp number (sender) the message will be sent from. Note: channel_id is not the Meta WABA ID. It is baat.ai’s internal representation for different communication channels (e.g., multiple WhatsApp senders, Email, SMS, etc.).
\n
source (string): The source of the message, e.g., the name of the application or platform.
\n

`header_params` (array of strings)

The header_params array is used to provide additional context at the top of the template message. Depending on the template configuration in Meta:

If the header type is text, a single value like \"Your OTP is 123456\" should be passed.
\n
If the header type is image, video, or document, provide a publicly accessible URL or a media ID. For example: \"https://example.com/banner.jpg\".
\n

`button_params` (array of strings)

The button_params array is used to populate dynamic values in template buttons. Supported button types include:

URL Buttons: Accept dynamic URLs like \"https://example.com/offer/{{1}}\".
\n
Call Buttons: Accept phone numbers such as \"+919999999999\".
\n
Quick Replies: No dynamic values required.
\n

Response

The response will contain the status of the message sending process.

Error Responses

400 Bad Request: The request was invalid or cannot be served. The possible cause could be missing or incorrect parameters in the request payload.
\n
401 Unauthorized: The request lacks valid authentication credentials. Ensure that the X-API-KEY is included and correct.
\n
5xx Server Error: Indicates that the server failed to fulfill a valid request. This could be due to server-side issues.
\n

\n","urlObject":{"protocol":"https","path":["v1","whatsapp","messages"],"host":["apis","baat","ai"],"query":[],"variable":[]}},"response":[{"id":"22307127-4548-49ed-ae1a-5b9551cb8161","name":"Send WhatsApp Template Message","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"body_params\": [\"\", \"\"],\n \"header_params\": [\"\"],\n \"button_params\": [\"\"],\n \"language_code\": \"\",\n \"template_name\": \"\"\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message_id\": \"7leyrX9mNyBYnns9BJGj\",\n \"status\": \"queued\"\n}"}],"_postman_id":"6b02b841-2d8f-40a8-9925-c98b6945913f"},{"name":"Send WhatsApp Template","id":"adac1a69-f51d-468c-89f2-22a3dad8b7bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"template_name\": \"\",\n \"language_code\": \"\",\n \"body_params_by_name\": {\n \"customer_name\": \"\",\n \"order_id\": \"\"\n },\n \"header_params_by_name\": {\n \"invoice_image\": \"https://example.com/invoices/42.png\"\n },\n \"button_params_by_name\": {\n \"tracking_id\": \"\"\n }\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages","description":"

Here's a description you can paste into the request's Description field (just under the request name at the top):

Send a WhatsApp template message to a contact through a configured WAC_API channel.

Supports both classic positional templates ({{1}}, {{2}}) and named-parameter templates ({{customer_name}}). The caller picks the shape — the server does not convert between them.

Authentication

Pass your API key in the X-API-KEY header. Keys are scoped to an organization and channel.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`phone_number`	string	yes	Recipient mobile number without country code.
`contact_name`	string	yes	Contact display name. Used if the contact is created on first send.
`template_id`	string	yes	Template name as registered with Meta.
`channel_id`	number	yes	Baat channel id to send from.
`message.language_code`	string	yes	Template language, e.g. `en`, `en_US`.
`message.template_name`	string	yes	Must match `template_id`.
`message.body_params`	string[]	no	Classic positional body values, in order.
`message.header_params`	string[]	no	Classic positional header values.
`message.button_params_by_index`	object	no	`{ \"\": \"\" }` for URL button placeholders in classic templates.
`message.body_params_by_name`	object	no	`{ \"\": \"\" }` for named-template body placeholders.
`message.header_params_by_name`	object	no	Same shape, for named-template header placeholders.
`message.button_params_by_name`	object	no	Same shape, for named-template URL button placeholders. The server resolves the button index by matching the placeholder against the cached template.

Use either the positional fields or the \\*_by_name fields per component, matching how the template was created. Sending a named param whose name doesn't appear in the template returns 400.

Response

200 OK with the created message record on success. 400 for validation or unknown-parameter errors. 401 for missing/invalid API key.

\n","urlObject":{"protocol":"https","path":["v1","whatsapp","messages"],"host":["apis","baat","ai"],"query":[],"variable":[]}},"response":[{"id":"091b1349-25b7-47e4-935e-beda8ea564ec","name":"Send WhatsApp Template","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"template_name\": \"\",\n \"language_code\": \"\",\n \"body_params_by_name\": {\n \"customer_name\": \"\",\n \"order_id\": \"\"\n },\n \"header_params_by_name\": {\n \"invoice_image\": \"https://example.com/invoices/42.png\"\n },\n \"button_params_by_name\": {\n \"tracking_id\": \"\"\n }\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages"},"status":"Accepted","code":202,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Apr 2026 16:49:27 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=28915D2310921F92AD58CE696DB8C266; Path=/; HttpOnly"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Kong-Upstream-Latency","value":"26"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/3.5.0"},{"key":"X-Kong-Request-Id","value":"c96a3e57cc3465079feafe3d07fbaf6d"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message_id\": \"6612a7e4f1a2b8c9d0e12345\",\n \"status\": \"queued\"\n }"},{"id":"9c4d1423-cf09-48a7-99ba-77168b791d04","name":"Send WhatsApp Template","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"template_name\": \"\",\n \"language_code\": \"\",\n \"body_params_by_name\": {\n \"customer_name\": \"\",\n \"order_id\": \"\"\n },\n \"header_params_by_name\": {\n \"invoice_image\": \"https://example.com/invoices/42.png\"\n },\n \"button_params_by_name\": {\n \"tracking_id\": \"\"\n }\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"status\": \"Named button parameter 'no_such_param' does not match any URL button placeholder in template 'order_named'\"\n }"},{"id":"f2c329f8-ec78-45eb-8258-caf3f30062d4","name":"Send WhatsApp Template","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"template_name\": \"\",\n \"language_code\": \"\",\n \"body_params_by_name\": {\n \"customer_name\": \"\",\n \"order_id\": \"\"\n },\n \"header_params_by_name\": {\n \"invoice_image\": \"https://example.com/invoices/42.png\"\n },\n \"button_params_by_name\": {\n \"tracking_id\": \"\"\n }\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"status\": \"unauthorized\"\n }"},{"id":"59aeaa1f-60b7-49a2-8cf0-04f5f5e5d76c","name":"Send WhatsApp Template","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"template_name\": \"\",\n \"language_code\": \"\",\n \"body_params_by_name\": {\n \"customer_name\": \"\",\n \"order_id\": \"\"\n },\n \"header_params_by_name\": {\n \"invoice_image\": \"https://example.com/invoices/42.png\"\n },\n \"button_params_by_name\": {\n \"tracking_id\": \"\"\n }\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"status\": \"internal_server_error\"\n }"},{"id":"3e8b4233-6d55-4873-9296-6458575d659a","name":"Send WhatsApp Template","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"body_params\": [\"\", \"\"],\n \"header_params\": [\"\"],\n \"button_params\": [\"\"],\n \"language_code\": \"\",\n \"template_name\": \"\"\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages"},"status":"Accepted","code":202,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message_id\": \"6612a7e4f1a2b8c9d0e12345\",\n \"status\": \"queued\"\n }"},{"id":"3dff8b1b-50be-4e6f-aacc-1c027b468bb9","name":"Send WhatsApp Template","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"body_params\": [\"\", \"\"],\n \"header_params\": [\"\"],\n \"button_params\": [\"\"],\n \"language_code\": \"\",\n \"template_name\": \"\"\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"status\": \"Body parameter count mismatch for template 'order_created'\"\n }"},{"id":"06aad061-86f0-48a1-ba52-ad5cbb3154e3","name":"Send WhatsApp Template","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"91XXXXXXXXXX\",\n \"contact_name\": \"\",\n \"message\": {\n \"body_params\": [\"\", \"\"],\n \"header_params\": [\"\"],\n \"button_params\": [\"\"],\n \"language_code\": \"\",\n \"template_name\": \"\"\n },\n \"template_id\": \"\",\n \"channel_id\": 0,\n \"source\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apis.baat.ai/v1/whatsapp/messages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{ \"success\": false, \"status\": \"unauthorized\" }"}],"_postman_id":"adac1a69-f51d-468c-89f2-22a3dad8b7bf"}]}

Request Header Parameters

Request Body Parameters

header_params (array of strings)

button_params (array of strings)

Response

Error Responses

Authentication

Request body

Response

`header_params` (array of strings)

`button_params` (array of strings)