Skip to main content
POST
One endpoint for every kind of WhatsApp message, chosen with type:
  • text: a free-form message, only inside the 24-hour window opened by the contact’s last message. This is how a bot replies.
  • template: an approved template, any time. Needed to write first or after the 24-hour window.
  • image, video, audio, document, sticker: a media message, with media. Also only inside the 24-hour window.
Permission: WhatsApp or Transactional. The workspace comes from the API key: never send a companyId. To know whether a message was delivered, read or failed, subscribe your webhook to whatsapp.message.status.

Send a session text

Use this to reply to an inbound message from your bot. It only succeeds inside the 24-hour window opened by the customer’s last message — which is exactly the case when you are answering a reply.

Send a template

Templates are required to start a conversation or to message outside the 24-hour window.
Template authoring, categories (UTILITY / AUTHENTICATION / MARKETING), the 24-hour window, named vs. positional variables and the full component reference are covered in detail on Send WhatsApp Template. This page documents the same endpoint from the “connect your bot” angle.

Send media

Set type to the media kind and pass a media object. The file is addressed exactly one way — media.link (a public URL the provider fetches) or media.providerMediaId (a media already uploaded to the sending number). A caption is supported on image / video / document; a filename only on document; a sticker takes neither. Like a session text, media is only deliverable inside the 24-hour customer window.

Add quick-reply buttons

A text message can carry up to 3 buttons (label up to 20 characters). When the contact taps one, the whatsapp.message.received event carries message.button = { id, title }, so your bot knows which one.

Choosing the sender (multi-number)

If the company has more than one connected number, set sender to the number you want to send from — either the phone number (any formatting) or the Meta phone_number_id:
An unknown or foreign sender returns WHATSAPP_SENDER_NOT_FOUND. Source valid values from List WhatsApp Senders.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
recipient
string
required

Phone number of the recipient including country code

Example:

"393471234567"

type
enum<string>
required

text = a free-form message (only inside the 24-hour window opened by the contact's last message). template = an approved template. image, video, audio, document, sticker = a media message, with media (also only inside the 24-hour window).

Available options:
text,
template,
image,
video,
audio,
document,
sticker
Example:

"template"

text
string

Plain text message (used only if type is 'text')

Example:

"Hello, this is a plain text message."

template
object

Address the template with exactly one of id or name — both, or neither, is rejected with 400. id is accepted only by POST /public/v1/templates/whatsapp/send; the legacy endpoint requires name.

media
object

Required when type is a media kind. Pass exactly one of link or providerMediaId.

buttons
object[]

Up to 3 quick-reply buttons under a text message (not with templates or media). When the contact taps one, the whatsapp.message.received event carries message.button = { id, title }.

Maximum array length: 3
sender
string

Multi-sender: the connected WhatsApp number to send from, when the company has more than one. Accepts the phone number (E.164 or any formatting, e.g. +39 351 1234567) or the Meta phone_number_id. Omit to use the company preferred number. An unknown/foreign number returns WHATSAPP_SENDER_NOT_FOUND. List valid values via GET /public/v1/templates/whatsapp/senders.

Example:

"+393511234567"

contactSource
string

Contact source recorded when the recipient does not exist yet and is created as a Minimo contact by this send (defaults to WhatsApp). Does not modify existing contacts. The contact source type is always system-defined and cannot be set by the caller.

Maximum string length: 64
Example:

"WhatsApp"

Response

Message sent successfully

data
object