Sign in

v1

latestOpenAPI 3.0.22026-08-045831103.6 KB
Messages

Send Direct Send utility message (no template)

Send a free-form WhatsApp Official utility message via Direct Send, without a pre-approved template. Requires the owner to have the WHATSAPP_OFFICIAL_DIRECT_SEND feature flag enabled and the WhatsApp Business Account not to be restricted; otherwise returns 403. Supports an optional header/footer, up to one CTA URL button OR up to three quick-reply buttons, and an optional validity window (ttl_seconds, 30s–12h). Returns immediately with QUEUED status.

post/v2/messages/direct-send

Headers

api-tokenstring required

API Token

Request body

channel_account_idstring uuid required

UUID of the WhatsApp Official channel account

contact_idstring uuid required

UUID of the contact to send the message to

bodystring required

Utility message text (1–1024 characters)

headerstring

Optional text header (max 60 chars). Requires at least one button — returns 400 otherwise (Meta only delivers header/footer on interactive messages).

footerstring

Optional footer (max 60 chars). Requires at least one button — returns 400 otherwise (Meta only delivers header/footer on interactive messages).

ttl_secondsinteger

Optional validity window in seconds (30s–12h). Omit to use Meta's default; the message is discarded if not delivered within this window.

chat_idstring uuid

Optional UUID of an existing chat. If not provided, the system will find or create a chat automatically.

Example request

{
  "channel_account_id": "550e8400-e29b-41d4-a716-446655440001",
  "contact_id": "550e8400-e29b-41d4-a716-446655440002",
  "body": "Seu pedido #1234 foi confirmado.",
  "buttons": [
    {
      "url": "https://example.com/order/1234"
    }
  ],
  "ttl_seconds": 3600,
  "chat_id": "550e8400-e29b-41d4-a716-446655440003"
}

Response

Message queued for sending

statusinteger

Example response

{
  "status": 201,
  "data": {
    "success": true,
    "message_id": "550e8400-e29b-41d4-a716-446655440099",
    "chat_id": "550e8400-e29b-41d4-a716-446655440003",
    "status": "QUEUED"
  }
}