Send a WhatsApp form to one person

SENDS a real WhatsApp message with a button that opens a form, from the official Business number to exactly one person. Use only when the user asks to send this form to this person. The person must have messaged the Business number in the last 24 hours. A DRAFT form is sent in test mode with a banner; use that only to test with the user's own phone or team. Read the answers later with list_form_responses. Never use for bulk sends or automatic retries; acceptance is not delivery.

post/api/v1/tools/send_whatsapp_form

Request

  • Base URL: https://whatsync.app
  • URL: https://whatsync.app/api/v1/tools/send_whatsapp_form
  • 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.

form_idstring required
conversationIdstring

The exact conversation_id from another WhatSync tool

phoneNumberstring

One recipient's phone number with country code

bodystring required

Message text shown above the button

buttonTextstring required

Button label that opens the form, no emoji

headerstring
footerstring

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.