Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document defaults when creating polls #6968

Merged
merged 1 commit into from
Jul 2, 2024
Merged

Document defaults when creating polls #6968

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/resources/Poll.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ The main difference is that the request has `duration` which eventually becomes

###### Poll Create Request Object Structure

| Field | Type | Description |
|-------------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| question | [Poll Media Object](#DOCS_RESOURCES_POLL/poll-media-object-poll-media-object-structure) | The question of the poll. Only `text` is supported. |
| answers | List of [Poll Answer Objects](#DOCS_RESOURCES_POLL/poll-answer-object-poll-answer-object-structure) | Each of the answers available in the poll, up to 10 |
| duration | integer | Number of hours the poll should be open for, up to 32 days |
| allow_multiselect | boolean | Whether a user can select multiple answers |
| layout_type? | integer | The [layout type](#DOCS_RESOURCES_POLL/layout-type) of the poll. Defaults to... DEFAULT! |
| Field | Type | Description |
|--------------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| question | [Poll Media Object](#DOCS_RESOURCES_POLL/poll-media-object-poll-media-object-structure) | The question of the poll. Only `text` is supported. |
| answers | List of [Poll Answer Objects](#DOCS_RESOURCES_POLL/poll-answer-object-poll-answer-object-structure) | Each of the answers available in the poll, up to 10 |
| duration? | integer | Number of hours the poll should be open for, up to 32 days. Defaults to 24 |
| allow_multiselect? | boolean | Whether a user can select multiple answers. Defaults to false |
| layout_type? | integer | The [layout type](#DOCS_RESOURCES_POLL/layout-type) of the poll. Defaults to... DEFAULT! |

### Layout Type

Expand Down