Back to ZoomCreate A Meeting Poll
Polls allow the meeting host to survey attendees. Create a poll for a meeting.
Scopes: meeting:write:admin
meeting:write
Rate Limit Label: Light
Prerequisites:
- Host user type must be Pro or higher plan.
- Polling feature must be enabled in the host's account.
- Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
Input
type: object
properties:
parameters:
type: object
properties:
meetingId:
format: int64
type: integer
example: 85746065
description: |-
The meeting's ID.
When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.
required:
- meetingId
title: Parameters
data:
type: object
title: Data
properties:
anonymous:
default: false
description: |-
Allow meeting participants to answer poll questions anonymously.
This value defaults to `false`.
type: boolean
example: true
poll_type:
description: >-
The type of poll:
* `1` — Poll.
* `2` — Advanced Poll. This feature must be enabled in your Zoom
account.
* `3` — Quiz. This feature must be enabled in your Zoom account.
This value defaults to `1`.
enum:
- 1
- 2
- 3
type: integer
example: 2
questions:
description: Information about the poll's questions.
type: array
items:
type: object
properties:
answer_max_character:
description: >-
The allowed maximum number of characters. This field only
applies to `short_answer` and `long_answer` polls:
* For `short_answer` polls, a maximum of 500 characters.
* For `long_answer` polls, a maximum of 2,000 characters.
type: integer
example: 200
answer_min_character:
description: >-
The allowed minimum number of characters. This field only
applies to `short_answer` and `long_answer` polls. You must
provide at least a **one** character minimum value.
minimum: 1
type: integer
example: 1
answer_required:
default: false
description: >-
Whether participants must answer the question:
* `true` — The participant must answer the question.
* `false` — The participant does not need to answer the
question.
**Note:**
* When the poll's `type` value is `1` (Poll), this value
defaults to `true`.
* When the poll's `type` value is the `2` (Advanced Poll) or `3`
(Quiz) values, this value defaults to `false`.
type: boolean
example: false
answers:
description: >-
The poll question's available answers. This field requires a
**minimum** of two answers.
* For `single` and `multiple` polls, you can only provide a
maximum of 10 answers.
* For `matching` polls, you can only provide a maximum of 16
answers.
* For `rank_order` polls, you can only provide a maximum of
seven answers.
minItems: 2
type: array
items:
type: string
example: Extremely useful
case_sensitive:
default: false
description: >-
Whether the correct answer is case sensitive. This field only
applies to `fill_in_the_blank` polls:
* `true` — The answer is case-sensitive.
* `false` — The answer is not case-sensitive.
This value defaults to `false`.
type: boolean
example: false
name:
description: >-
The poll question, up to 255 characters.
For `fill_in_the_blank` polls, this field is the poll's
question. For each value that the user must fill in, ensure that
there are the same number of `right_answers` values.
maxLength: 255
type: string
example: How useful was this meeting?
prompts:
description: >-
Information about the prompt questions. This field only applies
to `matching` and `rank_order` polls. You **must** provide a
minimum of two prompts, up to a maximum of 10 prompts.
type: array
items:
type: object
properties:
prompt_question:
description: The question prompt's title.
type: string
example: How are you?
prompt_right_answers:
description: >-
The question prompt's correct answers:
* For `matching` polls, you must provide a minimum of two
correct answers, up to a maximum of 10 correct answers.
* For `rank_order` polls, you can only provide one correct
answer.
type: array
items:
type: string
example: Good
rating_max_label:
description: |-
The high score label used for the `rating_max_value` field.
This field only applies to the `rating_scale` poll.
type: string
example: Extremely Likely
rating_max_value:
description: |-
The rating scale's maximum value, up to a maximum value of 10.
This field only applies to the `rating_scale` poll.
maximum: 10
type: integer
example: 4
rating_min_label:
description: |-
The low score label used for the `rating_min_value` field.
This field only applies to the `rating_scale` poll.
type: string
example: Not likely
rating_min_value:
description: >-
The rating scale's minimum value. This value cannot be less than
zero.
This field only applies to the `rating_scale` poll.
minimum: 0
type: integer
example: 0
right_answers:
description: >-
The poll question's correct answer(s). This field is
**required** if the poll's `type` value is `3` (Quiz).
For `single` and `matching` polls, this field only accepts one answer.
minItems: 1
type: array
items:
type: string
example: Good
show_as_dropdown:
default: false
description: |-
Whether to display the radio selection as a drop-down box:
* `true` — Show as a drop-down box.
* `false` — Do not show as a drop-down box.
This value defaults to `false`.
type: boolean
example: false
type:
description: |-
The poll's question and answer type:
* `single` — Single choice.
* `multiple` — Multiple choice.
* `matching` — Matching.
* `rank_order` — Rank order.
* `short_answer` — Short answer.
* `long_answer` — Long answer.
* `fill_in_the_blank` — Fill in the blank.
* `rating_scale` — Rating scale.
enum:
- single
- multiple
- matching
- rank_order
- short_answer
- long_answer
- fill_in_the_blank
- rating_scale
type: string
x-enum-descriptions:
- Single choice
- Multiple choice
- Matching
- Rank order
- Short answer
- Long answer
- Fill in the blank
- Rating scale
example: single
title:
description: The poll's title, up to 64 characters.
maxLength: 64
type: string
example: Learn something new
Output
type: object
title: Meeting and Webinar Polling Object
properties:
id:
description: Meeting Poll ID
type: string
example: QalIoKWLTJehBJ8e1xRrbQ
status:
description: >-
Status of the Meeting Poll:<br>`notstart` - Poll not started<br>`started`
- Poll started<br>`ended` - Poll ended<br>`sharing` - Sharing poll results
enum:
- notstart
- started
- ended
- sharing
type: string
x-enum-descriptions:
- Poll not start
- Poll started
- Poll ended
- Poll is sharing
example: notstart
anonymous:
default: false
description: |-
Allow meeting participants to answer poll questions anonymously.
This value defaults to `false`.
type: boolean
example: true
poll_type:
description: |-
The type of poll:
* `1` — Poll.
* `2` — Advanced Poll. This feature must be enabled in your Zoom account.
* `3` — Quiz. This feature must be enabled in your Zoom account.
This value defaults to `1`.
enum:
- 1
- 2
- 3
type: integer
example: 2
questions:
description: Information about the poll's questions.
type: array
items:
type: object
properties:
answer_max_character:
description: >-
The allowed maximum number of characters. This field only applies to
`short_answer` and `long_answer` polls:
* For `short_answer` polls, a maximum of 500 characters.
* For `long_answer` polls, a maximum of 2,000 characters.
type: integer
example: 200
answer_min_character:
description: >-
The allowed minimum number of characters. This field only applies to
`short_answer` and `long_answer` polls. You must provide at least a
**one** character minimum value.
minimum: 1
type: integer
example: 1
answer_required:
default: false
description: >-
Whether participants must answer the question:
* `true` — The participant must answer the question.
* `false` — The participant does not need to answer the question.
**Note:**
* When the poll's `type` value is `1` (Poll), this value defaults to
`true`.
* When the poll's `type` value is the `2` (Advanced Poll) or `3`
(Quiz) values, this value defaults to `false`.
type: boolean
example: false
answers:
description: >-
The poll question's available answers. This field requires a
**minimum** of two answers.
* For `single` and `multiple` polls, you can only provide a maximum
of 10 answers.
* For `matching` polls, you can only provide a maximum of 16
answers.
* For `rank_order` polls, you can only provide a maximum of seven
answers.
minItems: 2
type: array
items:
type: string
example: Extremely useful
case_sensitive:
default: false
description: >-
Whether the correct answer is case sensitive. This field only
applies to `fill_in_the_blank` polls:
* `true` — The answer is case-sensitive.
* `false` — The answer is not case-sensitive.
This value defaults to `false`.
type: boolean
example: false
name:
description: >-
The poll question, up to 255 characters.
For `fill_in_the_blank` polls, this field is the poll's question.
For each value that the user must fill in, ensure that there are the
same number of `right_answers` values.
maxLength: 255
type: string
example: How useful was this meeting?
prompts:
description: >-
Information about the prompt questions. This field only applies to
`matching` and `rank_order` polls. You **must** provide a minimum of
two prompts, up to a maximum of 10 prompts.
type: array
items:
type: object
properties:
prompt_question:
description: The question prompt's title.
type: string
example: How are you?
prompt_right_answers:
description: >-
The question prompt's correct answers:
* For `matching` polls, you must provide a minimum of two
correct answers, up to a maximum of 10 correct answers.
* For `rank_order` polls, you can only provide one correct
answer.
type: array
items:
type: string
example: Good
rating_max_label:
description: |-
The high score label used for the `rating_max_value` field.
This field only applies to the `rating_scale` poll.
type: string
example: Extremely Likely
rating_max_value:
description: |-
The rating scale's maximum value, up to a maximum value of 10.
This field only applies to the `rating_scale` poll.
maximum: 10
type: integer
example: 4
rating_min_label:
description: |-
The low score label used for the `rating_min_value` field.
This field only applies to the `rating_scale` poll.
type: string
example: Not likely
rating_min_value:
description: >-
The rating scale's minimum value. This value cannot be less than
zero.
This field only applies to the `rating_scale` poll.
minimum: 0
type: integer
example: 0
right_answers:
description: >-
The poll question's correct answer(s). This field is **required** if
the poll's `type` value is `3` (Quiz).
For `single` and `matching` polls, this field only accepts one answer.
minItems: 1
type: array
items:
type: string
example: Good
show_as_dropdown:
default: false
description: |-
Whether to display the radio selection as a drop-down box:
* `true` — Show as a drop-down box.
* `false` — Do not show as a drop-down box.
This value defaults to `false`.
type: boolean
example: false
type:
description: |-
The poll's question and answer type:
* `single` — Single choice.
* `multiple` — Multiple choice.
* `matching` — Matching.
* `rank_order` — Rank order.
* `short_answer` — Short answer.
* `long_answer` — Long answer.
* `fill_in_the_blank` — Fill in the blank.
* `rating_scale` — Rating scale.
enum:
- single
- multiple
- matching
- rank_order
- short_answer
- long_answer
- fill_in_the_blank
- rating_scale
type: string
x-enum-descriptions:
- Single choice
- Multiple choice
- Matching
- Rank order
- Short answer
- Long answer
- Fill in the blank
- Rating scale
example: single
title:
description: The poll's title, up to 64 characters.
maxLength: 64
type: string
example: Learn something new