Send a button message

Send an interactive message with buttons. Each button has a type: reply, copy, url, call or pix.

Combination rules enforced by the server:

Up to 3 reply buttons per message.
reply buttons cannot be mixed with any other type.
pix button must be sent ALONE (no other button in the same message).

WhatsApp client rendering quirks (NOT enforced by the server, but verified in the field):

WhatsApp Web: only reply-only messages (up to 3) OR CTAs grouped together (copy + url + call) render correctly.
Do NOT mix reply with CTA buttons (copy/url/call) — the message will not appear on WhatsApp Web.

Required body fields: number, title, description, footer, buttons.

Request body

delayinteger

Typing delay (milliseconds) applied before sending the message.

descriptionstring

Body description text (required).

footerstring

Footer text (required).

formatJidboolean

If false, skips automatic formatting/validation of number into a JID.

imageUrlstring

Optional image URL used as header for reply-only buttons.

mentionAllboolean

Mention every participant (groups only).

mentionedJidstring[]

JIDs to mention inside the body text.

numberstring

Destination phone number.

titlestring

Header title (required).

videoUrlstring

Optional video URL used as header for reply-only buttons.

Example request

{
  "buttons": [
    {
      "copyCode": "PROMO2026",
      "currency": "BRL",
      "displayText": "Quero saber mais",
      "id": "btn_info",
      "key": "12345678900",
      "keyType": "cpf",
      "name": "Minha Loja",
      "phoneNumber": "+5582988898565",
      "type": "reply",
      "url": "https://evolutionapi.com"
    }
  ],
  "delay": 1200,
  "description": "Confira as condicoes abaixo",
  "footer": "Evolution GO",
  "number": "5582988898565",
  "title": "Oferta especial"
}

Response

success

GinH required

v1

Send a button message

Request body

Example request

Response