Send one WhatsApp message now

SENDS a real WhatsApp message to exactly one recipient from the agent. Use only after the user explicitly asks to send to this recipient. For a new official Business conversation, use an approved template and confirm recipient opt-in. Templates with media headers or buttons that need a value are not supported; fixed buttons are. The recipient cannot be the connected Business number itself. For a free-form Business reply, the recipient must have messaged within 24 hours. QR sends use the connected QR account. Never use this tool for bulk sends, guesses, or automatic retries; provider acceptance is not delivery.

post/api/v1/tools/send_message

Request

  • Base URL: https://whatsync.app
  • URL: https://whatsync.app/api/v1/tools/send_message
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring

Stable key for a write; body idempotencyKey takes precedence.

Request body

idempotencyKeystring required

Unique key for this intended action. Reuse exactly on retries; use a new key only for a new action.

channel'qr' | 'business'

Required when both accounts are connected; templates always use Business

conversationIdstring

The exact conversation_id value from another WhatSync tool, if sending into an existing chat

phoneNumberstring

One recipient's phone number with country code

textstring

Exact free-form message to send; omit for a template

templateNamestring

Approved Business template name; omit for free-form text

templateLanguagestring
templateParametersstring[]
expectedPreviewstring

Optional exact rendered template text to verify against Meta's current template: header, filled-in body, footer and 'Button: ...' lines, separated by blank lines. Omit it unless you copied it from a previous WhatSync result

recipientOptInConfirmedboolean

Required true for Business templates only when the recipient agreed to receive messages

Response

JSON result. Every response includes X-Request-Id.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.