Skip to main content
POST
/
api
/
v1
/
whatsapp
/
template
Send WhatsApp template message
curl --request POST \
  --url https://{subdomain}.mihu.ai/api/v1/whatsapp/template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "32d8fc98-be1e-4d32-a12e-146f397fb1cb",
  "templateId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "phoneNumber": "+12345678900",
  "parameters": {
    "field1": "John Doe",
    "field2": "Order #12345",
    "field3": "2024-01-15"
  },
  "header": {
    "type": "image",
    "url": "https://example.com/image.jpg",
    "filename": "invoice.pdf"
  }
}
'
{
  "success": true,
  "message": "WhatsApp template message sent successfully",
  "data": {
    "messageId": "wamid.HBgMOTA1NDM1NTA2Njc3FQIAEhggRDdBQjlFM0Q2Q0E4OEJBMDE5NkMyNEZBNjVCNzE2MzYA",
    "templateName": "order_confirmation",
    "recipientPhone": "+12345678900",
    "conversationId": 456
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.mihu.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
​
agentId
string<uuid>
required

UUID of the Agent. Must exist and have WhatsApp configured.

Example:

"32d8fc98-be1e-4d32-a12e-146f397fb1cb"

​
templateId
string<uuid>
required

UUID of the approved WhatsApp template to send. You can get the templateId from the templates section.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
phoneNumber
string
required

Phone number of the recipient in E.164 format (e.g., +1234567890).

Example:

"+12345678900"

​
parameters
object

Optional object containing parameters to fill template placeholders. Keys should be field1, field2, etc. corresponding to {{1}}, {{2}}, etc. in the template. Omit this field if template has no placeholders.

Example:
{
  "field1": "John Doe",
  "field2": "Order #12345",
  "field3": "2024-01-15"
}
​
header
object

Optional header media definition. Supports image, video, or document with a publicly accessible URL.

Response

Success

​
success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

​
message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"WhatsApp template message sent successfully"

​
data
object