Ze da API icon

Ze da API

WhatsApp API powered by Ze da API - Send messages, manage groups, contacts and more

Actions137

Poll → Send Poll

AI-generated

Summary

Send a poll to one or more recipients

Inputs

  • phone (required) — Recipient phone number with country code
  • message (required) — The poll question/title
  • poll (required) — Poll options (minimum 2)
  • pollMaxOptions — Number of options a user can select (0 = multi-select)
  • delayMessage — Delay in seconds before sending (0 = API default 1-3s random)
  • delayTyping — Show typing indicator before sending (1-15, 0 = off)
  • messageId — Message ID to reply to
  • scheduledFor — ISO 8601 timestamp for scheduled delivery (overrides Delay Message). Must be in the future.
  • requestOptions — Batching and advanced settings
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible
  • proxy — HTTP proxy to use. If authentication is required it can be defined as follow: http://username:password@myproxy:3128
  • timeout — Time in ms to wait for the server to send response headers (and start the response body) before aborting the request

Output shape

a JSON object representing the sent poll message

Contains the created message ID on success; on failure an error envelope is returned.

Examples

Example 1: Send a poll to a single recipient

Phone: 5511999999999, Message: 'Best vacation?', Options: [{Name: 'Beach'}, {Name: 'Mountains'}], Delay Message: 2

Example 2: Schedule a poll for later delivery

Phone: 5511999999999, Message: 'Reminder', Options: [{Name: 'Yes'}, {Name: 'No'}], ScheduledFor: '2025-01-01T12:00:00Z', Delay Typing: 5

Example 3: Send a multi‑select poll with batching

Phone: 5511999999999, Message: 'Rate this product', Poll: [{Name: '1 star'}, {Name: '2 stars'}, {Name: '3 stars'}], PollMaxOptions: 0, RequestOptions: {Batch: {BatchSize: 100}}

Links

Discussion