Add and launch a poll
create_surveyAdd a poll, quiz, rating, or word cloud to a room and launch it so the audience answers on their phones; save drafts or keep results private.
Instructions
Add a poll, quiz, rating or word cloud to a room and launch it so the audience answers on their phones (launching needs an open room); launch=false saves a draft instead. Use it during a session to ask the audience something. type=poll takes 2-8 options (allow_multiple for several choices), quiz takes options plus correct_option (zero-based), rating takes scale 5 or 10, word_cloud takes no options. Results are shown to the audience by default; show_results=false keeps them private. Returns the survey with its id and the request_id; keep that request_id, because calling again with the same survey fields, that request_id and launch=true is how a saved draft is launched once the room is open. Read answers with get_survey_results and end a live survey with close_survey. Needs rooms:write; pass a request_id UUID and resend the same one to retry safely.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | Six-character room code, for example ABC234 | |
| type | Yes | ||
| scale | No | Rating: 5 (default) or 10 points | |
| launch | No | Default true; false saves a draft | |
| options | No | Poll or quiz: 2-8 distinct options | |
| question | Yes | The question, 1-200 characters | |
| low_label | No | Rating: optional label for the lowest point | |
| high_label | No | Rating: optional label for the highest point | |
| request_id | No | Optional UUID; resend the same one to retry safely after a lost reply | |
| show_results | No | Default true: the audience may see results; false keeps them private. Screens show only the live surveys or the latest closed batch | |
| allow_multiple | No | Poll only: allow several choices | |
| correct_option | No | Quiz: zero-based index of the correct option |