Skip to content

[onboarding] Clarify how emoji are currently accepted in update and create endpoints #6479

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

Merged
merged 7 commits into from
Nov 2, 2023
Merged

[onboarding] Clarify how emoji are currently accepted in update and create endpoints #6479

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
27ebe8d
[onboarding] Clarify how emoji are currently accepted in update and
hammerdr Oct 10, 2023
4a5aa24
Update docs/resources/Guild.md
shaydewael Nov 2, 2023
5454c5d
Update docs/resources/Guild.md
shaydewael Nov 2, 2023
1f05f09
Update docs/resources/Guild.md
shaydewael Nov 2, 2023
4875735
Update docs/resources/Guild.md
shaydewael Nov 2, 2023
f98dfc9
Update docs/resources/Guild.md
shaydewael Nov 2, 2023
55e275e
Update docs/resources/Guild.md
shaydewael Nov 2, 2023
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
22 changes: 14 additions & 8 deletions docs/resources/Guild.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,14 +554,20 @@ Represents the [onboarding](https://support.discord.com/hc/en-us/articles/110749

###### Prompt Option Structure

| Field | Type | Description |
|-------------|----------------------------------------------------|-------------------------------------------------------------------|
| id | snowflake | ID of the prompt option |
| channel_ids | array of snowflakes | IDs for channels a member is added to when the option is selected |
| role_ids | array of snowflakes | IDs for roles assigned to a member when the option is selected |
| emoji | [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object | Emoji of the option |
| title | string | Title of the option |
| description | ?string | Description of the option |
| Field | Type | Description |
|-----------------|----------------------------------------------------|-------------------------------------------------------------------|
| id | snowflake | ID of the prompt option |
| channel_ids | array of snowflakes | IDs for channels a member is added to when the option is selected |
| role_ids | array of snowflakes | IDs for roles assigned to a member when the option is selected |
| emoji? | [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object | Emoji of the option (see below) |
| emoji_id? | snowflake | Emoji ID of the option (see below) |
| emoji_name? | string | Emoji name of the option (see below) |
| emoji_animated? | boolean | Whether the emoji is animated (see below) |
| title | string | Title of the option |
| description | ?string | Description of the option |

> warn
> When creating or updating a prompt option, the `emoji_id`, `emoji_name`, and `emoji_animated` fields must be used instead of the emoji object.

###### Onboarding Mode

Expand Down