Public API Reference

Botinx API documentation

Download Postman collection Environment API keys Logs
API ReferenceTemplates

Create template

POST

Submit a WhatsApp template for review and store the template against the selected WhatsApp channel.

POSThttps://app.botinx.com/api/v1/public/v1/templates
X-API-Key required
string
Your Botinx public API key.
channel_id required
string
Botinx WhatsApp channel id.
name required
string
Template name. Use lowercase words and underscores.
language required
string
Template language, for example en_US.
category required
string
MARKETING, UTILITY, or AUTHENTICATION.
template_type
string
STANDARD, CAROUSEL, CATALOG, MULTI_PRODUCT, AUTHENTICATION.
header_type
string
NONE, TEXT, IMAGE, VIDEO, or DOCUMENT.
body required
string
Template body. Variables use {{1}}, {{2}}, etc.
footer
string
Optional footer text.
buttons
array
Optional template buttons.
example_body_values
array
Sample values required for Meta review when variables are used.

Request example

JSON

{
  "channel_id": "{{CHANNEL_ID}}",
  "name": "order_update",
  "language": "en_US",
  "category": "UTILITY",
  "template_type": "STANDARD",
  "header_type": "TEXT",
  "header_text": "Order update",
  "body": "Hi {{1}}, your order {{2}} is now {{3}}.",
  "footer": "Thank you",
  "example_body_values": ["John", "#1024", "shipped"]
}

Responses

200

Successful response body.

application/json

{
  "success": true,
  "message": "Template submitted to Meta",
  "data": {
    "_id": "665f...",
    "name": "order_update",
    "status": "PENDING",
    "source": "PUBLIC_API"
  }
}