Auto replies
4 tools

Auto replies tools

Create, edit, pause and delete keyword auto-replies that answer incoming messages automatically, with reply buttons, a list or a link button.

Badges:Read onlyWrites dataSends to WhatsAppDestructive
list_auto_replies#

List auto-replies

Read only

WhatsApp auto-replies on the connected number: trigger words, reply text, buttons, list or link button (interactive), whether it sends a file (has_media, media_type; files are attached in the dashboard) and whether each is active. An auto-reply with is_dormant: true is over the plan limit and does not fire.

Takes no parameters.

create_auto_reply#

Create an auto-reply

Writes data

Adds an auto-reply that answers incoming WhatsApp messages matching its triggers, optionally with buttons, a list or a link button (interactive). Pass is_active: false to save it paused. Fails with DUPLICATE_AUTO_REPLY when another auto-reply already uses the same word.

Parameters (5)›
  • triggersrequired

    object[]

    No extra notes.
  • match_mode

    "any" | "all"

    any fires when one trigger matches; all needs every trigger.
  • textrequired

    string

    The text sent back automatically.
  • interactive

    object

    Buttons, a list or a link button sent with the text. Tapping a button or row sends its title back, which another auto-reply can answer.
  • is_active

    boolean

    false keeps the auto-reply saved but paused.
update_auto_reply#

Update, pause or resume an auto-reply

Writes data

Changes a WhatsApp auto-reply's triggers, match mode, text or buttons (interactive, null removes them), or turns it on or off with is_active; omitted fields stay; its file stays. Turning one on needs an active plan; pausing never does.

Parameters (6)›
  • auto_reply_idrequired

    string

    An auto_reply_id from list_auto_replies.
  • triggers

    object[]

    No extra notes.
  • match_mode

    "any" | "all"

    any fires when one trigger matches; all needs every trigger.
  • text

    string

    The text sent back automatically.
  • interactive

    object

    No extra notes.
  • is_active

    boolean

    false keeps the auto-reply saved but paused.
delete_auto_reply#

Delete an auto-reply

Destructive

Removes a WhatsApp auto-reply for good. To stop it for now use update_auto_reply with is_active: false. Owner or admin keys only.

Parameters (1)›
  • auto_reply_idrequired

    string

    An auto_reply_id from list_auto_replies.