AuditLogActionType
The type of action that occurred Related endpoints| Value | Description |
|---|---|
1 | Guild settings were updated |
10 | Channel was created |
11 | Channel was updated |
12 | Channel was deleted |
13 | Permission overwrite was created |
14 | Permission overwrite was updated |
15 | Permission overwrite was deleted |
20 | Member was kicked |
21 | Members were pruned |
22 | Member was banned |
23 | Member ban was removed |
24 | Member was updated |
25 | Member roles were updated |
26 | Member was moved to a different voice channel |
27 | Member was disconnected from a voice channel |
28 | Bot was added to the guild |
30 | Role was created |
31 | Role was updated |
32 | Role was deleted |
40 | Invite was created |
41 | Invite was updated |
42 | Invite was deleted |
50 | Webhook was created |
51 | Webhook was updated |
52 | Webhook was deleted |
60 | Emoji was created |
61 | Emoji was updated |
62 | Emoji was deleted |
90 | Sticker was created |
91 | Sticker was updated |
92 | Sticker was deleted |
72 | Message was deleted |
73 | Messages were bulk deleted |
74 | Message was pinned |
75 | Message was unpinned |
AuditLogChangeSchema
| Field | Type | Description |
|---|---|---|
| key | string | The field that changed |
| new_value? | string | number | boolean | string[] | number[] | AuditLogChangeSchemaNewValueOneOf5 | null | Value after the change |
| old_value? | string | number | boolean | string[] | number[] | AuditLogChangeSchemaNewValueOneOf5 | null | Value before the change |
AuditLogWebhookResponse
| Field | Type | Description |
|---|---|---|
| avatar_hash? | ?string | The hash of the webhook avatar |
| channel_id? | ?SnowflakeType | The channel ID this webhook posts to |
| guild_id? | ?SnowflakeType | The guild ID this webhook belongs to |
| id | SnowflakeType | The unique identifier for this webhook |
| name | string | The name of the webhook |
| type | WebhookType |
ChannelCreateRequest
Related endpoints Type: ChannelCreateTextRequest | ChannelCreateVoiceRequest | ChannelCreateCategoryRequest | ChannelCreateLinkRequestChannelPositionUpdateRequest
Related endpoints Type: ChannelPositionUpdateRequestItem[]DefaultMessageNotifications
Default notification level for new members| Value | Description |
|---|---|
0 | Notify on all messages |
1 | Notify only on mentions |
EnabledToggleRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| enabled | boolean | Whether to enable or disable the feature |
GuildAdminResponse
| Field | Type | Description |
|---|---|---|
| banner | ?string | The hash of the guild banner |
| features | GuildFeatureSchema[] | Array of guild feature flags |
| icon | ?string | The hash of the guild icon |
| id | SnowflakeType | The unique identifier for this guild |
| member_count | integer (int32) | The number of members in the guild |
| name | string | The name of the guild |
| owner_id | SnowflakeType | The ID of the guild owner |
GuildAssetItemSchema
| Field | Type | Description |
|---|---|---|
| animated | boolean | |
| creator_id | SnowflakeType | |
| id | SnowflakeType | |
| media_url | string | |
| name | string |
GuildAuditLogEntryResponse
| Field | Type | Description |
|---|---|---|
| action_type | AuditLogActionType | |
| changes? | AuditLogChangeSchema[] | Changes made to the target |
| id | SnowflakeType | The unique identifier for this audit log entry |
| options? | GuildAuditLogEntryResponseOptions | Additional options depending on action type |
| reason? | string | The reason provided for the action |
| target_id? | ?string | The ID of the affected entity (user, channel, role, invite code, etc.) |
| user_id? | ?SnowflakeType | The user ID of the user who performed the action |
GuildAuditLogListResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| audit_log_entries | GuildAuditLogEntryResponse[] | Array of audit log entries |
| users | UserPartialResponse[] | Users referenced in the audit log entries |
| webhooks | AuditLogWebhookResponse[] | Webhooks referenced in the audit log entries |
GuildBanCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| ban_duration_seconds? | integer (int53) | Duration of the ban in seconds (0 for permanent, or a valid temporary duration) |
| delete_message_days? | integer (int32) | Number of days of messages to delete from the banned user (0-7) |
| reason? | ?string | The reason for the ban (max 512 characters) |
GuildBanResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| banned_at | string (date-time) | ISO8601 timestamp of when the ban was issued |
| expires_at? | ?string (date-time) | ISO8601 timestamp of when the ban expires (null if permanent) |
| moderator_id | SnowflakeType | The ID of the moderator who issued the ban |
| reason? | ?string | The reason for the ban |
| user | UserPartialResponse |
GuildCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| empty_features? | boolean | Whether to create the guild without default features |
| icon? | ?Base64ImageType | Base64-encoded image data for the guild icon |
| name | string | The name of the guild (1-100 characters) |
GuildDeleteRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| mfa_code? | string | MFA verification code from authenticator app or SMS |
| mfa_method? | GuildUpdateRequestMfaMethod | MFA method to use for verification |
| password? | PasswordType | |
| webauthn_challenge? | string | WebAuthn challenge string |
| webauthn_response? | JSON value | WebAuthn authentication response |
GuildEmojiBulkCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| emojis | GuildEmojiCreateRequest[] | Array of emoji objects to create (1-50 emojis per batch) |
GuildEmojiBulkCreateResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| failed | GuildEmojiBulkCreateResponseFailedItem[] | Emojis that failed to create |
| success | GuildEmojiResponse[] | Successfully created emojis |
GuildEmojiCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| image | Base64ImageType | |
| name | string | The name of the emoji (2-32 characters, alphanumeric and underscores only) |
GuildEmojiResponse
Related endpointsPOST /guilds/{guild_id}/emojisPOST /packs/emojis/{pack_id}PATCH /guilds/{guild_id}/emojis/{emoji_id}PATCH /packs/emojis/{pack_id}/{emoji_id}
| Field | Type | Description |
|---|---|---|
| animated | boolean | Whether this emoji is animated |
| id | SnowflakeType | The unique identifier for this emoji |
| name | string | The name of the emoji |
GuildEmojiUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| name | string | The name of the emoji (2-32 characters, alphanumeric and underscores only) |
GuildEmojiWithUserListResponse
Related endpoints Type: GuildEmojiWithUserResponse[]GuildEmojiWithUserResponse
| Field | Type | Description |
|---|---|---|
| animated | boolean | Whether this emoji is animated |
| id | SnowflakeType | The unique identifier for this emoji |
| name | string | The name of the emoji |
| user | UserPartialResponse |
GuildExplicitContentFilter
Level of content filtering for explicit media| Value | Description |
|---|---|
0 | Media content will not be scanned |
1 | Media content from members without roles will be scanned |
2 | Media content from all members will be scanned |
GuildFeatureSchema
A guild feature flag| Value | Description |
|---|---|
ANIMATED_ICON | Guild can have an animated icon |
ANIMATED_BANNER | Guild can have an animated banner |
BANNER | Guild can have a banner |
DETACHED_BANNER | Guild banner is detached from splash |
INVITE_SPLASH | Guild can have an invite splash |
INVITES_DISABLED | Guild has invites disabled |
TEXT_CHANNEL_FLEXIBLE_NAMES | Guild allows flexible text channel names |
MORE_EMOJI | Guild has increased emoji slots |
MORE_STICKERS | Guild has increased sticker slots |
UNLIMITED_EMOJI | Guild has unlimited emoji slots |
UNLIMITED_STICKERS | Guild has unlimited sticker slots |
EXPRESSION_PURGE_ALLOWED | Guild allows purging expressions |
VANITY_URL | Guild can have a vanity URL |
VERIFIED | Guild is verified |
VIP_VOICE | Guild has VIP voice features |
UNAVAILABLE_FOR_EVERYONE | Guild is unavailable for everyone |
UNAVAILABLE_FOR_EVERYONE_BUT_STAFF | Guild is unavailable except for staff |
VISIONARY | Guild is a visionary guild |
OPERATOR | Guild is an operator guild |
LARGE_GUILD_OVERRIDE | Guild has large guild overrides enabled |
VERY_LARGE_GUILD | Guild has increased member capacity enabled |
MT_MESSAGE_SCHEDULING | Guild has managed message scheduling |
MT_EXPRESSION_PACKS | Guild has managed expression packs |
GuildFolderFlags
Bitfield for guild folder display behaviour Type: Bitflags32| Flag | Value | Description |
|---|---|---|
| SHOW_ICON_WHEN_COLLAPSED | 1 | Show the selected icon instead of guild previews when the folder is collapsed |
GuildInviteMetadataResponse
| Field | Type | Description |
|---|---|---|
| channel | ChannelPartialResponse | |
| code | string | The unique invite code |
| created_at | string (date-time) | ISO8601 timestamp of when the invite was created |
| expires_at? | ?string (date-time) | ISO8601 timestamp of when the invite expires |
| guild | GuildInviteMetadataResponseGuild | The guild this invite is for |
| inviter? | ?UserPartialResponse | The user who created the invite |
| max_age | integer (int32) | The duration in seconds before the invite expires |
| max_uses | integer (int32) | The maximum number of times this invite can be used |
| member_count | integer (int32) | The approximate total member count of the guild |
| presence_count | integer (int32) | The approximate online member count of the guild |
| temporary | boolean | Whether the invite grants temporary membership |
| type | enum<0> | The type of invite (guild) |
| uses | integer (int32) | The number of times this invite has been used |
GuildInviteResponse
| Field | Type | Description |
|---|---|---|
| channel | ChannelPartialResponse | |
| code | string | The unique invite code |
| expires_at? | ?string (date-time) | ISO8601 timestamp of when the invite expires |
| guild | GuildInviteMetadataResponseGuild | The guild this invite is for |
| inviter? | ?UserPartialResponse | The user who created the invite |
| member_count | integer (int32) | The approximate total member count of the guild |
| presence_count | integer (int32) | The approximate online member count of the guild |
| temporary | boolean | Whether the invite grants temporary membership |
| type | enum<0> | The type of invite (guild) |
GuildMemberProfileFlags
Member profile flags Type: Bitflags32| Flag | Value | Description |
|---|---|---|
| AVATAR_UNSET | 1 | Guild member avatar is unset |
| BANNER_UNSET | 2 | Guild member banner is unset |
GuildMemberResponse
Related endpointsGET /guilds/{guild_id}/membersGET /guilds/{guild_id}/members/{user_id}GET /guilds/{guild_id}/members/@mePATCH /guilds/{guild_id}/members/{user_id}PATCH /guilds/{guild_id}/members/@me
| Field | Type | Description |
|---|---|---|
| accent_color? | ?Int32Type | The accent colour of the member guild profile as an integer |
| avatar? | ?string | The hash of the member guild-specific avatar |
| banner? | ?string | The hash of the member guild-specific banner |
| communication_disabled_until? | ?string (date-time) | ISO8601 timestamp until which the member is timed out |
| deaf | boolean | Whether the member is deafened in voice channels |
| joined_at | string (date-time) | ISO8601 timestamp of when the user joined the guild |
| mute | boolean | Whether the member is muted in voice channels |
| nick? | ?string | The nickname of the member in this guild |
| profile_flags? | ?GuildMemberProfileFlags | |
| roles | SnowflakeType[] | Array of role IDs the member has |
| user | UserPartialResponse |
GuildMemberSearchRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| is_bot? | boolean | Filter by bot status |
| join_source_type? | integer (int53)[] | Filter by join source types |
| joined_at_gte? | integer (int53) | Filter members who joined at or after this unix timestamp |
| joined_at_lte? | integer (int53) | Filter members who joined at or before this unix timestamp |
| limit? | integer (int32) | Maximum number of results to return |
| offset? | integer (int64) | Number of results to skip for pagination |
| query? | string | Text to search for in usernames, global names, and nicknames |
| role_ids? | SnowflakeType[] | Filter by role IDs (member must have all specified roles) |
| sort_by? | GuildMemberSearchRequestSortBy | Sort results by field |
| sort_order? | SearchAuditLogsRequestSortOrder | Sort order |
| source_invite_code? | string[] | Filter by invite codes used to join |
| user_created_at_gte? | integer (int53) | Filter members whose account was created at or after this unix timestamp |
| user_created_at_lte? | integer (int53) | Filter members whose account was created at or before this unix timestamp |
GuildMemberSearchResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| guild_id | SnowflakeType | Guild ID |
| indexing | boolean | Whether the guild members are currently being indexed |
| members | GuildMemberSearchResult[] | Matching members |
| page_result_count | integer (int53) | Number of results in this page |
| total_result_count | integer (int53) | Total number of matching results |
GuildMemberSearchResult
| Field | Type | Description |
|---|---|---|
| discriminator | string | Zero-padded 4-digit discriminator |
| global_name | ?string | Global display name |
| guild_id | SnowflakeType | Guild ID |
| id | SnowflakeType | Composite ID (guildId:userId) |
| is_bot | boolean | Whether the user is a bot |
| joined_at | number | Unix timestamp of when the member joined |
| nickname | ?string | Guild nickname |
| role_ids | SnowflakeType[] | Role IDs |
| supplemental | GuildMemberSearchResultSupplemental | Supplemental members-search-only metadata that is not part of the base guild member payload |
| user_id | SnowflakeType | User ID |
| username | string | Username |
GuildMemberUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| accent_color? | ?integer (int32) | The accent color for the member guild profile as an integer |
| avatar? | ?Base64ImageType | Base64-encoded image data for the member guild avatar |
| banner? | ?Base64ImageType | Base64-encoded image data for the member guild banner |
| bio? | ?string | The member guild profile bio (1-320 characters) |
| channel_id? | ?SnowflakeType | The voice channel ID to move the member to |
| communication_disabled_until? | ?string (date-time) | ISO8601 timestamp until which the member is timed out |
| connection_id? | ?SnowflakeType | The voice connection ID for the member |
| deaf? | boolean | Whether the member is deafened in voice channels |
| mute? | boolean | Whether the member is muted in voice channels |
| nick? | ?string | The nickname to set for the member (1-32 characters) |
| profile_flags? | ?GuildMemberProfileFlags | |
| pronouns? | ?string | The member guild profile pronouns (1-40 characters) |
| roles? | SnowflakeType[] | Array of role IDs to assign to the member (max 100) |
| timeout_reason? | ?string | The reason for timing out the member (1-512 characters) |
GuildMFALevel
Required MFA level for moderation actions| Value | Description |
|---|---|
0 | Guild has no MFA requirement |
1 | Guild requires 2FA for moderation actions |
GuildOperations
Bitmask of disabled guild operations Type: Bitflags32| Flag | Value | Description |
|---|---|---|
| PUSH_NOTIFICATIONS | 1 | Allow push notifications for this guild |
| EVERYONE_MENTIONS | 2 | Allow @everyone mentions in this guild |
| TYPING_EVENTS | 4 | Enable typing indicator events |
| INSTANT_INVITES | 8 | Allow creation of instant invites |
| SEND_MESSAGE | 16 | Allow sending messages in the guild |
| REACTIONS | 32 | Allow adding reactions to messages |
| MEMBER_LIST_UPDATES | 64 | Enable member list update events |
GuildReportCategoryEnum
Category of the guild report| Value | Description |
|---|---|
harassment | Guild facilitates harassment, bullying, or intimidation |
hate_speech | Guild promotes hatred against protected groups |
extremist_community | Guild promotes extremist or terrorist ideologies |
illegal_activity | Guild promotes or facilitates illegal activities |
child_safety | Guild endangers minors or hosts child abuse content |
raid_coordination | Guild coordinates attacks on other communities |
spam | Guild used for spamming or bulk messaging |
malware_distribution | Guild distributes malware or malicious software |
other | Other violations not covered by specific categories |
GuildResponse
Related endpointsGET /guilds/{guild_id}GET /users/@me/guildsPOST /guildsPOST /guilds/{guild_id}/transfer-ownershipPATCH /guilds/{guild_id}PATCH /guilds/{guild_id}/detached-bannerPATCH /guilds/{guild_id}/text-channel-flexible-names
| Field | Type | Description |
|---|---|---|
| afk_channel_id? | ?SnowflakeType | The ID of the AFK voice channel |
| afk_timeout | integer (int32) | AFK timeout in seconds before moving users to the AFK channel |
| banner? | ?string | The hash of the guild banner |
| banner_height? | ?Int32Type | The height of the guild banner in pixels |
| banner_width? | ?Int32Type | The width of the guild banner in pixels |
| default_message_notifications | DefaultMessageNotifications | Default notification level for new members |
| disabled_operations | GuildOperations | |
| embed_splash? | ?string | The hash of the embedded invite splash |
| embed_splash_height? | ?Int32Type | The height of the embedded invite splash in pixels |
| embed_splash_width? | ?Int32Type | The width of the embedded invite splash in pixels |
| explicit_content_filter | GuildExplicitContentFilter | Level of content filtering for explicit media |
| features | GuildFeatureSchema[] | Array of guild feature flags |
| icon? | ?string | The hash of the guild icon |
| id | SnowflakeType | The unique identifier for this guild |
| message_history_cutoff? | ?string (date-time) | ISO8601 timestamp controlling how far back members without Read Message History can access messages. When null, no historical access is allowed. |
| mfa_level | GuildMFALevel | Required MFA level for moderation actions |
| name | string | The name of the guild |
| nsfw_level | NSFWLevel | The NSFW level of the guild |
| owner_id | SnowflakeType | The ID of the guild owner |
| permissions? | ?string (int64) | |
| rules_channel_id? | ?SnowflakeType | The ID of the rules channel |
| splash? | ?string | The hash of the guild splash screen |
| splash_card_alignment | enum<0, 1, 2> | The alignment of the splash card |
| splash_height? | ?Int32Type | The height of the guild splash in pixels |
| splash_width? | ?Int32Type | The width of the guild splash in pixels |
| system_channel_flags | SystemChannelFlags | |
| system_channel_id? | ?SnowflakeType | The ID of the channel where system messages are sent |
| vanity_url_code? | ?string | The vanity URL code for the guild |
| verification_level | GuildVerificationLevel | Required verification level for members to participate |
GuildRoleCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| color? | integer (int32) | The color of the role as an integer (default: 0) |
| name | string | The name of the role (1-100 characters) |
| permissions? | UnsignedInt64Type |
GuildRoleHoistPositionItem
| Field | Type | Description |
|---|---|---|
| hoist_position | integer (int53) | The new hoist position for the role |
| id | SnowflakeType |
GuildRoleHoistPositionsRequest
Related endpoints Type: GuildRoleHoistPositionItem[]GuildRolePositionItem
| Field | Type | Description |
|---|---|---|
| id | SnowflakeType | |
| position? | integer (int53) | The new position for the role |
GuildRolePositionsRequest
Related endpoints Type: GuildRolePositionItem[]GuildRoleResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| color | integer (int32) | The colour of the role as an integer |
| hoist | boolean | Whether this role is displayed separately in the member list |
| hoist_position? | ?Int32Type | The position of the role in the hoisted member list |
| id | SnowflakeType | The unique identifier for this role |
| mentionable | boolean | Whether this role can be mentioned by anyone |
| name | string | The name of the role |
| permissions | string (int64) | The permissions bitfield for the role |
| position | integer (int32) | The position of the role in the role hierarchy |
| unicode_emoji? | ?string | The unicode emoji for this role |
GuildRoleUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| color? | integer (int32) | The color of the role as an integer |
| hoist? | boolean | Whether the role should be displayed separately in the member list |
| hoist_position? | ?integer (int53) | The position of the role in the hoisted member list |
| mentionable? | boolean | Whether the role can be mentioned by anyone |
| name? | string | The name of the role (1-100 characters) |
| permissions? | UnsignedInt64Type |
GuildStickerBulkCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| stickers | GuildStickerCreateRequest[] | Array of sticker objects to create (1-50 stickers per batch) |
GuildStickerBulkCreateResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| failed | GuildEmojiBulkCreateResponseFailedItem[] | Stickers that failed to create |
| success | GuildStickerResponse[] | Successfully created stickers |
GuildStickerCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| description? | ?string | Description of the sticker (1-500 characters) |
| image | Base64ImageType | |
| name | string | The name of the sticker (2-30 characters) |
| tags? | string[] | Array of autocomplete/suggestion tags (max 10 tags, each 1-30 characters) |
GuildStickerResponse
Related endpointsPOST /guilds/{guild_id}/stickersPOST /packs/stickers/{pack_id}PATCH /guilds/{guild_id}/stickers/{sticker_id}PATCH /packs/stickers/{pack_id}/{sticker_id}
| Field | Type | Description |
|---|---|---|
| animated | boolean | Whether this sticker is animated |
| description | string | The description of the sticker |
| id | SnowflakeType | The unique identifier for this sticker |
| name | string | The name of the sticker |
| tags | string[] | Autocomplete/suggestion tags for the sticker |
GuildStickerUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| description? | ?string | Description of the sticker (1-500 characters) |
| name | string | The name of the sticker (2-30 characters) |
| tags? | string[] | Array of autocomplete/suggestion tags (max 10 tags, each 1-30 characters) |
GuildStickerWithUserListResponse
Related endpoints Type: GuildStickerWithUserResponse[]GuildStickerWithUserResponse
| Field | Type | Description |
|---|---|---|
| animated | boolean | Whether this sticker is animated |
| description | string | The description of the sticker |
| id | SnowflakeType | The unique identifier for this sticker |
| name | string | The name of the sticker |
| tags | string[] | Autocomplete/suggestion tags for the sticker |
| user | UserPartialResponse |
GuildTransferOwnershipRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| new_owner_id | SnowflakeType | |
| password? | PasswordType |
GuildUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| afk_channel_id? | ?SnowflakeType | The ID of the AFK voice channel |
| afk_timeout? | integer (int32) | AFK timeout in seconds (60-3600) before moving users to the AFK channel |
| banner? | ?Base64ImageType | Base64-encoded image data for the guild banner |
| default_message_notifications? | DefaultMessageNotifications | Default notification level for new members |
| embed_splash? | ?Base64ImageType | Base64-encoded image data for the embedded invite splash |
| explicit_content_filter? | GuildExplicitContentFilter | Level of content filtering for explicit media |
| features? | string[] | Array of guild feature strings |
| icon? | ?Base64ImageType | Base64-encoded image data for the guild icon |
| message_history_cutoff? | ?string (date-time) | ISO8601 timestamp controlling how far back members without Read Message History can access messages. Set to null to disable historical access. |
| mfa_code? | string | MFA verification code from authenticator app or SMS |
| mfa_level? | GuildMFALevel | Required MFA level for moderation actions |
| mfa_method? | GuildUpdateRequestMfaMethod | MFA method to use for verification |
| name? | string | The name of the guild (1-100 characters) |
| nsfw_level? | NSFWLevel | The NSFW level of the guild |
| password? | PasswordType | |
| splash? | ?Base64ImageType | Base64-encoded image data for the guild splash screen |
| splash_card_alignment? | GuildUpdateRequestSplashCardAlignment | Alignment of the splash card (center, left, or right) |
| system_channel_flags? | SystemChannelFlags | |
| system_channel_id? | ?SnowflakeType | The ID of the channel where system messages are sent |
| verification_level? | GuildVerificationLevel | Required verification level for members to participate |
| webauthn_challenge? | string | WebAuthn challenge string |
| webauthn_response? | JSON value | WebAuthn authentication response |
GuildVanityURLResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| code? | ?string | The vanity URL code for the guild |
| uses | integer (int32) | The number of times this vanity URL has been used |
GuildVanityURLUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| code? | ?string | The new vanity URL code (2-32 characters, alphanumeric and hyphens) |
GuildVanityURLUpdateResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| code | string | The new vanity URL code |
GuildVerificationLevel
Required verification level for members| Value | Description |
|---|---|
0 | Unrestricted |
1 | Must have verified email |
2 | Registered for more than 5 minutes |
3 | Member of the server for more than 10 minutes |
4 | Must have a verified phone number |
Int32Type
Related endpoints Type: integer (int32)JoinSourceType
How the member joined the guild| Value | Description |
|---|---|
0 | Member created the guild |
1 | Member joined via an instant invite |
2 | Member joined via the vanity URL |
3 | Member was added via a bot invite |
4 | Member was force-added by a platform administrator |
MyGuildMemberUpdateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| accent_color? | ?integer (int32) | The accent color for the member guild profile as an integer |
| avatar? | ?Base64ImageType | Base64-encoded image data for the member guild avatar |
| banner? | ?Base64ImageType | Base64-encoded image data for the member guild banner |
| bio? | ?string | The member guild profile bio (1-320 characters) |
| channel_id? | ?SnowflakeType | The voice channel ID to move the member to |
| communication_disabled_until? | ?string (date-time) | ISO8601 timestamp until which the member is timed out |
| connection_id? | ?SnowflakeType | The voice connection ID for the member |
| deaf? | boolean | Whether the member is deafened in voice channels |
| mute? | boolean | Whether the member is muted in voice channels |
| nick? | ?string | The nickname to set for the member (1-32 characters) |
| profile_flags? | ?GuildMemberProfileFlags | |
| pronouns? | ?string | The member guild profile pronouns (1-40 characters) |
| timeout_reason? | ?string | The reason for timing out the member (1-512 characters) |
NSFWLevel
The NSFW level of the guild| Value | Description |
|---|---|
0 | Default NSFW level |
1 | Guild has explicit content |
2 | Guild is safe |
3 | Guild is age-restricted |
SnowflakeType
Related endpointsGET /admin/guilds/{guild_id}/emojisGET /admin/guilds/{guild_id}/stickersGET /admin/system-dm-jobsGET /channels/{channel_id}GET /channels/{channel_id}/callGET /channels/{channel_id}/invitesGET /channels/{channel_id}/messagesGET /channels/{channel_id}/messages/{message_id}GET /channels/{channel_id}/messages/{message_id}/reactions/{emoji}GET /channels/{channel_id}/messages/pinsGET /channels/{channel_id}/rtc-regionsGET /channels/{channel_id}/webhooksGET /guilds/{guild_id}GET /guilds/{guild_id}/audit-logsGET /guilds/{guild_id}/bansGET /guilds/{guild_id}/channelsGET /guilds/{guild_id}/discoveryGET /guilds/{guild_id}/emojisGET /guilds/{guild_id}/invitesGET /guilds/{guild_id}/membersGET /guilds/{guild_id}/members/{user_id}GET /guilds/{guild_id}/members/@meGET /guilds/{guild_id}/rolesGET /guilds/{guild_id}/stickersGET /guilds/{guild_id}/vanity-urlGET /guilds/{guild_id}/webhooksGET /packs/{pack_id}/invitesGET /packs/emojis/{pack_id}GET /packs/stickers/{pack_id}GET /users/{target_id}/profileGET /users/{user_id}GET /users/@me/guildsGET /users/@me/mentionsGET /webhooks/{webhook_id}GET /webhooks/{webhook_id}/{token}POST /admin/discovery/applications/{guild_id}/approvePOST /admin/discovery/applications/{guild_id}/rejectPOST /admin/discovery/guilds/{guild_id}/removePOST /channels/{channel_id}/call/endPOST /channels/{channel_id}/call/ringPOST /channels/{channel_id}/call/stop-ringingPOST /channels/{channel_id}/invitesPOST /channels/{channel_id}/messagesPOST /channels/{channel_id}/messages/{message_id}/ackPOST /channels/{channel_id}/messages/{message_id}/memesPOST /channels/{channel_id}/messages/bulk-deletePOST /channels/{channel_id}/messages/schedulePOST /channels/{channel_id}/pins/ackPOST /channels/{channel_id}/typingPOST /channels/{channel_id}/webhooksPOST /discovery/guilds/{guild_id}/joinPOST /guilds/{guild_id}/channelsPOST /guilds/{guild_id}/deletePOST /guilds/{guild_id}/discoveryPOST /guilds/{guild_id}/emojisPOST /guilds/{guild_id}/emojis/bulkPOST /guilds/{guild_id}/members-searchPOST /guilds/{guild_id}/rolesPOST /guilds/{guild_id}/stickersPOST /guilds/{guild_id}/stickers/bulkPOST /guilds/{guild_id}/transfer-ownershipPOST /packs/{pack_id}/installPOST /packs/{pack_id}/invitesPOST /packs/emojis/{pack_id}POST /packs/emojis/{pack_id}/bulkPOST /packs/stickers/{pack_id}POST /packs/stickers/{pack_id}/bulkPOST /users/@me/relationships/{user_id}POST /webhooks/{webhook_id}/{token}POST /webhooks/{webhook_id}/{token}/githubPOST /webhooks/{webhook_id}/{token}/sentryPOST /webhooks/{webhook_id}/{token}/slackPUT /channels/{channel_id}/messages/{message_id}/reactions/{emoji}/@mePUT /channels/{channel_id}/permissions/{overwrite_id}PUT /channels/{channel_id}/pins/{message_id}PUT /channels/{channel_id}/recipients/{user_id}PUT /guilds/{guild_id}/bans/{user_id}PUT /guilds/{guild_id}/members/{user_id}/roles/{role_id}PUT /users/@me/channels/{channel_id}/pinPUT /users/@me/relationships/{user_id}PATCH /channels/{channel_id}PATCH /channels/{channel_id}/callPATCH /channels/{channel_id}/messages/{message_id}PATCH /guilds/{guild_id}PATCH /guilds/{guild_id}/channelsPATCH /guilds/{guild_id}/detached-bannerPATCH /guilds/{guild_id}/discoveryPATCH /guilds/{guild_id}/emojis/{emoji_id}PATCH /guilds/{guild_id}/members/{user_id}PATCH /guilds/{guild_id}/members/@mePATCH /guilds/{guild_id}/rolesPATCH /guilds/{guild_id}/roles/{role_id}PATCH /guilds/{guild_id}/roles/hoist-positionsPATCH /guilds/{guild_id}/stickers/{sticker_id}PATCH /guilds/{guild_id}/text-channel-flexible-namesPATCH /guilds/{guild_id}/vanity-urlPATCH /packs/{pack_id}PATCH /packs/emojis/{pack_id}/{emoji_id}PATCH /packs/stickers/{pack_id}/{sticker_id}PATCH /users/@me/guilds/{guild_id}/settingsPATCH /users/@me/relationships/{user_id}PATCH /webhooks/{webhook_id}PATCH /webhooks/{webhook_id}/{token}DELETE /channels/{channel_id}DELETE /channels/{channel_id}/messages/{message_id}DELETE /channels/{channel_id}/messages/{message_id}/attachments/{attachment_id}DELETE /channels/{channel_id}/messages/{message_id}/reactionsDELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji}DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji}/{target_id}DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji}/@meDELETE /channels/{channel_id}/messages/ackDELETE /channels/{channel_id}/permissions/{overwrite_id}DELETE /channels/{channel_id}/pins/{message_id}DELETE /channels/{channel_id}/recipients/{user_id}DELETE /guilds/{guild_id}/bans/{user_id}DELETE /guilds/{guild_id}/discoveryDELETE /guilds/{guild_id}/emojis/{emoji_id}DELETE /guilds/{guild_id}/members/{user_id}DELETE /guilds/{guild_id}/members/{user_id}/roles/{role_id}DELETE /guilds/{guild_id}/roles/{role_id}DELETE /guilds/{guild_id}/roles/hoist-positionsDELETE /guilds/{guild_id}/stickers/{sticker_id}DELETE /packs/{pack_id}DELETE /packs/{pack_id}/installDELETE /packs/emojis/{pack_id}/{emoji_id}DELETE /packs/stickers/{pack_id}/{sticker_id}DELETE /users/@me/channels/{channel_id}/pinDELETE /users/@me/guilds/{guild_id}DELETE /users/@me/mentions/{message_id}DELETE /users/@me/relationships/{user_id}DELETE /users/@me/saved-messages/{message_id}DELETE /webhooks/{webhook_id}DELETE /webhooks/{webhook_id}/{token}
SystemChannelFlags
System channel message flags Type: Bitflags32| Flag | Value | Description |
|---|---|---|
| SUPPRESS_JOIN_NOTIFICATIONS | 1 | Suppress member join notifications in system channel |
GuildUpdateRequestSplashCardAlignment
Alignment of the splash card (center, left, or right)| Value | Description |
|---|---|
0 | Splash card is centred |
1 | Splash card is aligned to the left |
2 | Splash card is aligned to the right |
GuildUpdateRequestMfaMethod
MFA method to use for verification| Value | Description |
|---|---|
totp | Time-based one-time password authentication via authenticator app |
sms | One-time password sent via text message |
webauthn | Security key or biometric authentication |
GuildMemberSearchRequestSortBy
Sort results by field| Value | Description |
|---|---|
joinedAt | - |
relevance | - |
AuditLogChangeSchemaNewValueOneOf5
Value after the change| Field | Type | Description |
|---|---|---|
| added | string[] | |
| removed | string[] |
ChannelPositionUpdateRequestItem
| Field | Type | Description |
|---|---|---|
| id | SnowflakeType | |
| lock_permissions? | boolean | Whether to sync permissions with the new parent |
| parent_id? | ?SnowflakeType | New parent category ID |
| position? | integer (int64) | New position for the channel |
GuildAuditLogEntryResponseOptions
Additional options depending on action type| Field | Type | Description |
|---|---|---|
| channel_id? | SnowflakeType | Channel ID for relevant actions |
| count? | number | Count of items affected |
| delete_member_days? | string | Number of days of messages to delete on member ban |
| id? | SnowflakeType | ID of the affected entity |
| integration_type? | number | Type of integration |
| inviter_id? | SnowflakeType | ID of the user who created the invite |
| max_age? | number | Maximum age of the invite in seconds |
| max_uses? | number | Maximum number of uses for the invite |
| members_removed? | number | Number of members removed |
| message_id? | SnowflakeType | Message ID for relevant actions |
| role_name? | string | Name of the role |
| temporary? | boolean | Whether the invite grants temporary membership |
| type? | number | Type identifier |
| uses? | number | Number of times the invite has been used |
GuildEmojiBulkCreateResponseFailedItem
Emojis that failed to create| Field | Type | Description |
|---|---|---|
| error | string | The error message explaining why the emoji failed to create |
| name | string | The name of the emoji that failed to create |
GuildInviteMetadataResponseGuild
The guild this invite is for| Field | Type | Description |
|---|---|---|
| banner? | ?string | The hash of the guild banner |
| banner_height? | ?Int32Type | The height of the guild banner in pixels |
| banner_width? | ?Int32Type | The width of the guild banner in pixels |
| embed_splash? | ?string | The hash of the embedded invite splash |
| embed_splash_height? | ?Int32Type | The height of the embedded invite splash in pixels |
| embed_splash_width? | ?Int32Type | The width of the embedded invite splash in pixels |
| features | GuildFeatureSchema[] | Array of guild feature flags |
| icon? | ?string | The hash of the guild icon |
| id | SnowflakeType | The unique identifier for this guild |
| name | string | The name of the guild |
| splash? | ?string | The hash of the guild splash screen |
| splash_card_alignment | enum<0, 1, 2> | The alignment of the splash card |
| splash_height? | ?Int32Type | The height of the guild splash in pixels |
| splash_width? | ?Int32Type | The width of the guild splash in pixels |
GuildMemberSearchResultSupplemental
Supplemental members-search-only metadata that is not part of the base guild member payload| Field | Type | Description |
|---|---|---|
| inviter_id | ?SnowflakeType | User ID of the member who sent the invite |
| join_source_type? | ?JoinSourceType | How the member joined |
| source_invite_code | ?string | Invite code used to join |