Skip to main content
POST
cURL (Windows)
The playground on this page is live. There is no test mode and no sandbox: pressing Send authenticates with the key you paste and really calls https://api.bulkneo.com — a send delivers a real WhatsApp message to the number you type, and an instance call really changes your account. Use your own number while you are exploring, and paste a key only from a machine you trust.Your browser remembers what you type into the playground, so a key you paste here is still in the Authorization box on your next visit. Nobody else sees it — it never leaves your machine and it is not part of this site — but on a shared or borrowed computer, clear the site data when you are done.
Ask a question with fixed answers — a delivery slot, a size, a preference.

Notes

  • question is capped at 255 characters.
  • options must contain 2 to 10 options, each up to 100 characters.
  • Options must all be different. WhatsApp counts votes by the option’s text, so two identical options make the result impossible to read. Duplicates are rejected with 400 invalid_request.
  • selectable_count is how many options one person may pick. It defaults to 1 and cannot exceed the number of options you sent.

Example

You cannot read the votes through this API. Polls render properly and people can vote, but there is no endpoint that returns the results and no webhook that reports them — you would have to look at the conversation in WhatsApp on the phone.If you need the answer back in your system, ask people to reply with a word instead: “Reply MORNING, AFTERNOON or EVENING.”

Authorizations

apikey
string
header
required

Your API key, sent in an apikey request header. Never in the URL, never as a Bearer token.

Headers

Idempotency-Key
string

OPTIONAL. A unique string you choose, 8-255 characters of letters, digits or . _ : ~ -

Send the same key with the same body again within 24 hours and the ORIGINAL result is returned without sending a second message — which is what makes a network retry safe. A different body on the same key is refused with 422 idempotency_key_reused rather than silently overwriting either result.

Responses carry Idempotency-Replayed: true|false while this is active. If that header is ABSENT, idempotency is not enabled on this deployment and retries will send again.

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9._:~-]{8,255}$

Body

application/json
instance_id
string<uuid>
required

Which of your connected numbers to send FROM. Copy it from your numbers screen in the portal, or from GET /v1/instances. It must belong to your account.

Example:

"3f9c1a2b-7d4e-4c81-9f0a-2b6d5e8c1a34"

to
string
required

The recipient, with country code and no leading zero — for example 919000000000. Spaces, dashes, brackets and a leading + are accepted and stripped; 6 to 15 digits must remain.

Example:

"919000000000"

question
string
required

The poll question. Up to 255 characters.

Required string length: 1 - 255
Example:

"Which delivery slot suits you?"

options
string[]
required

2 to 10 options, each 1 to 100 characters. They must all be different — WhatsApp counts votes by option text, so duplicates make the result unreadable and are rejected.

Required array length: 2 - 10 elements
Maximum string length: 100
Example:
selectable_count
integer
default:1

How many options one person may pick. Must be a whole number between 1 and the number of options you sent.

Required range: 1 <= x <= 10
quoted_message_id
string

Send this message as a reply, quoting an earlier one. Use the data.message_id returned by a previous send.

Maximum string length: 128
Example:

"3EB0C1D2F4A5B6C7D8E9"

quoted_from_me
boolean
default:false

Set true when the quoted message is one you sent from this number. Only valid together with quoted_message_id.

Response

Accepted for delivery. data.type is always poll on this endpoint.

success
boolean
data
object
request_id
string<uuid>