--- title: "PATCH /applications/{application_id}" method: PATCH path: "/applications/{application_id}" --- # PATCH /applications/{application_id} `PATCH /applications/{application_id}` ## Request body - ApplicationFormPartial - `description` object, nullable - `default` string, required - `localizations` object, nullable - `icon` string, byte, nullable - `cover_image` string, byte, nullable - `team_id` string, snowflake - `flags` integer, nullable - `interactions_endpoint_url` string, uri, nullable - `explicit_content_filter` union - 0 — inherit guild content filter setting - 1 — interactions will always be scanned - `max_participants` integer, nullable - `type` 4 - `tags` string[], nullable - `custom_install_url` string, uri, nullable - `install_params` ApplicationOAuth2InstallParams - `scopes` OAuth2Scopes[], nullable - union - 'identify' — allows /users/@me without email - 'email' — enables /users/@me to return an email - 'connections' — allows /users/@me/connections to return linked third-party accounts - 'guilds' — allows /users/@me/guilds to return basic information about all of a user's guilds - 'guilds.join' — allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild - 'guilds.members.read' — allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild - 'gdm.join' — allows your app to join users to a group dm - 'bot' — for oauth2 bots, this puts the bot in the user's selected guild by default - 'rpc' — for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval - 'rpc.notifications.read' — for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval - 'rpc.voice.read' — for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval - 'rpc.voice.write' — for local rpc server access, this allows you to update a user's voice settings - requires Discord approval - 'rpc.video.read' — for local rpc server access, this allows you to read a user's video status - requires Discord approval - 'rpc.video.write' — for local rpc server access, this allows you to update a user's video settings - requires Discord approval - 'rpc.screenshare.read' — for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval - 'rpc.screenshare.write' — for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval - 'rpc.activities.write' — for local rpc server access, this allows you to update a user's activity - requires Discord approval - 'webhook.incoming' — this generates a webhook that is returned in the oauth token response for authorization code grants - 'messages.read' — for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates) - 'applications.builds.upload' — allows your app to upload/update builds for a user's applications - requires Discord approval - 'applications.builds.read' — allows your app to read build data for a user's applications - 'applications.commands' — allows your app to use commands in a guild - 'applications.commands.permissions.update' — allows your app to update permissions for its commands in a guild a user has permissions to - 'applications.commands.update' — allows your app to update its commands using a Bearer token - client credentials grant only - 'applications.store.update' — allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications - 'applications.entitlements' — allows your app to read entitlements for a user's applications - 'activities.read' — allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval - 'activities.write' — allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER) - 'activities.invites.write' — allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER) - 'relationships.read' — allows your app to know a user's friends and implicit relationships - requires Discord approval - 'voice' — allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval - 'dm_channels.read' — allows your app to see information about the user's DMs and group DMs - requires Discord approval - 'role_connections.write' — allows your app to update a user's connection and metadata for the app - 'openid' — for OpenID Connect, this allows your app to receive user id and basic profile information - `permissions` integer, nullable - `role_connections_verification_url` string, uri, nullable - `integration_types_config` object, nullable - `event_webhooks_status` union - 1 — Webhook events are disabled by developer - 2 — Webhook events are enabled by developer - 3 — Webhook events are disabled by Discord, usually due to inactivity - `event_webhooks_url` string, uri, nullable — Event webhooks URL for the app to receive webhook events - `event_webhooks_types` ActionTypes[], nullable - union - 'TYPING_START' — User started typing in a channel - 'INVITE_CREATE' — Invite to a channel was created - 'INVITE_DELETE' — Invite to a channel was deleted - 'WEBHOOKS_UPDATE' — Guild channel webhook was created, updated, or deleted - 'CHANNEL_CREATE' — New guild channel created - 'VOICE_CHANNEL_STATUS_UPDATE' — Voice channel status was updated - 'CHANNEL_UPDATE' — Channel was updated - 'CHANNEL_DELETE' — Channel was deleted - 'CHANNEL_PINS_UPDATE' — Message was pinned or unpinned - 'THREAD_CREATE' — Thread created, also sent when being added to a private thread - 'THREAD_UPDATE' — Thread was updated - 'THREAD_DELETE' — Thread was deleted - 'THREAD_LIST_SYNC' — Sent when gaining access to a channel, contains all active threads in that channel - 'THREAD_MEMBER_UPDATE' — Thread member for the current user was updated - 'THREAD_MEMBERS_UPDATE' — Some user(s) were added to or removed from a thread - 'GUILD_CREATE' — Lazy-load for unavailable guild, guild became available, or user joined a new guild - 'GUILD_UPDATE' — Guild was updated - 'GUILD_DELETE' — Guild became unavailable, or user left/was removed from a guild - 'GUILD_EMOJIS_UPDATE' — Guild emojis were updated - 'GUILD_STICKERS_UPDATE' — Guild stickers were updated - 'GUILD_INTEGRATIONS_UPDATE' — Guild integration was updated - 'GUILD_MEMBER_ADD' — New user joined a guild - 'GUILD_MEMBER_UPDATE' — Guild member was updated - 'GUILD_MEMBER_REMOVE' — User was removed from a guild - 'GUILD_BAN_ADD' — User was banned from a guild - 'GUILD_BAN_REMOVE' — User was unbanned from a guild - 'GUILD_ROLE_CREATE' — Guild role was created - 'GUILD_ROLE_UPDATE' — Guild role was updated - 'GUILD_ROLE_DELETE' — Guild role was deleted - 'GUILD_MEMBERS_CHUNK' — Response to Request Guild Members - 'MESSAGE_CREATE' — Message was created - 'MESSAGE_UPDATE' — Message was edited - 'MESSAGE_DELETE' — Message was deleted - 'MESSAGE_DELETE_BULK' — Multiple messages were deleted at once - 'MESSAGE_REACTION_ADD' — User reacted to a message - 'MESSAGE_REACTION_REMOVE' — User removed a reaction from a message - 'MESSAGE_REACTION_REMOVE_ALL' — All reactions were explicitly removed from a message - 'MESSAGE_REACTION_REMOVE_EMOJI' — All reactions for a given emoji were explicitly removed from a message - 'USER_UPDATE' — Properties about the user changed - 'ENTITLEMENT_CREATE' — Entitlement was created - 'ENTITLEMENT_UPDATE' — Entitlement was updated - 'ENTITLEMENT_DELETE' — Entitlement was deleted - 'READY' — Contains the initial state information - 'RESUMED' — Response to Resume - 'PRESENCE_UPDATE' — User was updated - 'VOICE_STATE_UPDATE' — Someone joined, left, or moved a voice channel - 'VOICE_SERVER_UPDATE' — Guild's voice server was updated - 'LOBBY_MESSAGE_CREATE' — Sent when a message is created in a lobby - 'LOBBY_MESSAGE_UPDATE' — Sent when a message is updated in a lobby - 'LOBBY_MESSAGE_DELETE' — Sent when a message is deleted from a lobby - 'GAME_DIRECT_MESSAGE_CREATE' — Sent when a direct message is created during an active Social SDK session - 'GAME_DIRECT_MESSAGE_DELETE' — Sent when a direct message is deleted during an active Social SDK session - 'GAME_DIRECT_MESSAGE_UPDATE' — Sent when a direct message is updated during an active Social SDK session - 'INTERACTION_CREATE' — User used an interaction, such as an Application Command - 'INTEGRATION_CREATE' — Guild integration was created - 'INTEGRATION_UPDATE' — Guild integration was updated - 'INTEGRATION_DELETE' — Guild integration was deleted - 'APPLICATION_COMMAND_PERMISSIONS_UPDATE' — Application command permission was updated - 'APPLICATION_AUTHORIZED' — Sent when an app was authorized by a user to a server or their account - 'APPLICATION_DEAUTHORIZED' — Sent when an app was deauthorized by a user - 'STAGE_INSTANCE_CREATE' — Stage instance was created - 'STAGE_INSTANCE_UPDATE' — Stage instance was updated - 'STAGE_INSTANCE_DELETE' — Stage instance was deleted or closed - 'GUILD_AUDIT_LOG_ENTRY_CREATE' — A guild audit log entry was created - 'GUILD_SCHEDULED_EVENT_CREATE' — Guild scheduled event was created - 'GUILD_SCHEDULED_EVENT_UPDATE' — Guild scheduled event was updated - 'GUILD_SCHEDULED_EVENT_DELETE' — Guild scheduled event was deleted - 'GUILD_SCHEDULED_EVENT_USER_ADD' — User subscribed to a guild scheduled event - 'GUILD_SCHEDULED_EVENT_USER_REMOVE' — User unsubscribed from a guild scheduled event - 'AUTO_MODERATION_RULE_CREATE' — Auto Moderation rule was created - 'AUTO_MODERATION_RULE_UPDATE' — Auto Moderation rule was updated - 'AUTO_MODERATION_RULE_DELETE' — Auto Moderation rule was deleted - 'AUTO_MODERATION_ACTION_EXECUTION' — Auto Moderation rule was triggered and an action was executed (.e.g. a message was blocked) - 'GUILD_SOUNDBOARD_SOUNDS_UPDATE' - 'GUILD_SOUNDBOARD_SOUND_CREATE' - 'GUILD_SOUNDBOARD_SOUND_UPDATE' - 'GUILD_SOUNDBOARD_SOUND_DELETE' - 'QUEST_USER_ENROLLMENT' — User was added to a Quest (currently unavailable) - 'RATE_LIMITED' ## Response `200` 200 response for update_application - PrivateApplicationResponse - `id` string, snowflake, required - `name` string, required - `icon` string, nullable, required - `description` string, required - `type` 4, required - `cover_image` string - `primary_sku_id` string, snowflake - `bot` UserResponse - `id` string, snowflake, required - `username` string, required — the user's username, not unique across the platform - `avatar` string, nullable, required — the user's avatar hash - `discriminator` string, required — the user's Discord-tag - `public_flags` integer, required — the public flags on a user's account - `flags` integer, required - `bot` boolean — whether the user belongs to an OAuth2 application - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system) - `banner` string, nullable — the user's banner hash - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code - `global_name` string, nullable, required — the user's display name, if it is set - `avatar_decoration_data` UserAvatarDecorationResponse - `asset` string, required — the avatar decoration hash - `sku_id` string, snowflake, required - `collectibles` UserCollectiblesResponse - `nameplate` UserNameplateResponse, required - `sku_id` string, snowflake, required - `asset` string, required — Path to the nameplate asset - `label` string, required — The label of this nameplate. Currently unused - `palette` union, required - 'crimson' — Crimson color palette - 'berry' — Berry color palette - 'sky' — Sky color palette - 'teal' — Teal color palette - 'forest' — Forest color palette - 'bubble_gum' — Bubble gum color palette - 'violet' — Violet color palette - 'cobalt' — Cobalt color palette - 'clover' — Clover color palette - 'lemon' — Lemon color palette - 'white' — White color palette - 'black' — Black color palette - `primary_guild` UserPrimaryGuildResponse, required - `identity_guild_id` string, snowflake, required - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters - `badge` string, nullable, required — the server tag badge hash - `slug` string - `guild_id` string, snowflake - `rpc_origins` string[] - `bot_public` boolean - `bot_require_code_grant` boolean - `terms_of_service_url` string, uri - `privacy_policy_url` string, uri - `custom_install_url` string, uri - `install_params` ApplicationOAuth2InstallParamsResponse - `scopes` OAuth2Scopes[], required - union - 'identify' — allows /users/@me without email - 'email' — enables /users/@me to return an email - 'connections' — allows /users/@me/connections to return linked third-party accounts - 'guilds' — allows /users/@me/guilds to return basic information about all of a user's guilds - 'guilds.join' — allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild - 'guilds.members.read' — allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild - 'gdm.join' — allows your app to join users to a group dm - 'bot' — for oauth2 bots, this puts the bot in the user's selected guild by default - 'rpc' — for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval - 'rpc.notifications.read' — for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval - 'rpc.voice.read' — for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval - 'rpc.voice.write' — for local rpc server access, this allows you to update a user's voice settings - requires Discord approval - 'rpc.video.read' — for local rpc server access, this allows you to read a user's video status - requires Discord approval - 'rpc.video.write' — for local rpc server access, this allows you to update a user's video settings - requires Discord approval - 'rpc.screenshare.read' — for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval - 'rpc.screenshare.write' — for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval - 'rpc.activities.write' — for local rpc server access, this allows you to update a user's activity - requires Discord approval - 'webhook.incoming' — this generates a webhook that is returned in the oauth token response for authorization code grants - 'messages.read' — for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates) - 'applications.builds.upload' — allows your app to upload/update builds for a user's applications - requires Discord approval - 'applications.builds.read' — allows your app to read build data for a user's applications - 'applications.commands' — allows your app to use commands in a guild - 'applications.commands.permissions.update' — allows your app to update permissions for its commands in a guild a user has permissions to - 'applications.commands.update' — allows your app to update its commands using a Bearer token - client credentials grant only - 'applications.store.update' — allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications - 'applications.entitlements' — allows your app to read entitlements for a user's applications - 'activities.read' — allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval - 'activities.write' — allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER) - 'activities.invites.write' — allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER) - 'relationships.read' — allows your app to know a user's friends and implicit relationships - requires Discord approval - 'voice' — allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval - 'dm_channels.read' — allows your app to see information about the user's DMs and group DMs - requires Discord approval - 'role_connections.write' — allows your app to update a user's connection and metadata for the app - 'openid' — for OpenID Connect, this allows your app to receive user id and basic profile information - `permissions` string, required - `integration_types_config` object - `verify_key` string, required - `flags` integer, required - `flags_new` string, required - `max_participants` integer, nullable - `tags` string[] - `redirect_uris` string[], required - `interactions_endpoint_url` string, uri, nullable, required - `role_connections_verification_url` string, uri, nullable, required - `owner` UserResponse, required - `id` string, snowflake, required - `username` string, required — the user's username, not unique across the platform - `avatar` string, nullable, required — the user's avatar hash - `discriminator` string, required — the user's Discord-tag - `public_flags` integer, required — the public flags on a user's account - `flags` integer, required - `bot` boolean — whether the user belongs to an OAuth2 application - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system) - `banner` string, nullable — the user's banner hash - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code - `global_name` string, nullable, required — the user's display name, if it is set - `avatar_decoration_data` UserAvatarDecorationResponse - `asset` string, required — the avatar decoration hash - `sku_id` string, snowflake, required - `collectibles` UserCollectiblesResponse - `nameplate` UserNameplateResponse, required - `sku_id` string, snowflake, required - `asset` string, required — Path to the nameplate asset - `label` string, required — The label of this nameplate. Currently unused - `palette` union, required - 'crimson' — Crimson color palette - 'berry' — Berry color palette - 'sky' — Sky color palette - 'teal' — Teal color palette - 'forest' — Forest color palette - 'bubble_gum' — Bubble gum color palette - 'violet' — Violet color palette - 'cobalt' — Cobalt color palette - 'clover' — Clover color palette - 'lemon' — Lemon color palette - 'white' — White color palette - 'black' — Black color palette - `primary_guild` UserPrimaryGuildResponse, required - `identity_guild_id` string, snowflake, required - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters - `badge` string, nullable, required — the server tag badge hash - `approximate_guild_count` integer, required - `approximate_user_install_count` integer, required - `approximate_user_authorization_count` integer, required - `event_webhooks_url` string, uri, nullable - `event_webhooks_status` union - 1 — Webhook events are disabled by developer - 2 — Webhook events are enabled by developer - 3 — Webhook events are disabled by Discord, usually due to inactivity - `event_webhooks_types` ActionTypes[] - union - 'TYPING_START' — User started typing in a channel - 'INVITE_CREATE' — Invite to a channel was created - 'INVITE_DELETE' — Invite to a channel was deleted - 'WEBHOOKS_UPDATE' — Guild channel webhook was created, updated, or deleted - 'CHANNEL_CREATE' — New guild channel created - 'VOICE_CHANNEL_STATUS_UPDATE' — Voice channel status was updated - 'CHANNEL_UPDATE' — Channel was updated - 'CHANNEL_DELETE' — Channel was deleted - 'CHANNEL_PINS_UPDATE' — Message was pinned or unpinned - 'THREAD_CREATE' — Thread created, also sent when being added to a private thread - 'THREAD_UPDATE' — Thread was updated - 'THREAD_DELETE' — Thread was deleted - 'THREAD_LIST_SYNC' — Sent when gaining access to a channel, contains all active threads in that channel - 'THREAD_MEMBER_UPDATE' — Thread member for the current user was updated - 'THREAD_MEMBERS_UPDATE' — Some user(s) were added to or removed from a thread - 'GUILD_CREATE' — Lazy-load for unavailable guild, guild became available, or user joined a new guild - 'GUILD_UPDATE' — Guild was updated - 'GUILD_DELETE' — Guild became unavailable, or user left/was removed from a guild - 'GUILD_EMOJIS_UPDATE' — Guild emojis were updated - 'GUILD_STICKERS_UPDATE' — Guild stickers were updated - 'GUILD_INTEGRATIONS_UPDATE' — Guild integration was updated - 'GUILD_MEMBER_ADD' — New user joined a guild - 'GUILD_MEMBER_UPDATE' — Guild member was updated - 'GUILD_MEMBER_REMOVE' — User was removed from a guild - 'GUILD_BAN_ADD' — User was banned from a guild - 'GUILD_BAN_REMOVE' — User was unbanned from a guild - 'GUILD_ROLE_CREATE' — Guild role was created - 'GUILD_ROLE_UPDATE' — Guild role was updated - 'GUILD_ROLE_DELETE' — Guild role was deleted - 'GUILD_MEMBERS_CHUNK' — Response to Request Guild Members - 'MESSAGE_CREATE' — Message was created - 'MESSAGE_UPDATE' — Message was edited - 'MESSAGE_DELETE' — Message was deleted - 'MESSAGE_DELETE_BULK' — Multiple messages were deleted at once - 'MESSAGE_REACTION_ADD' — User reacted to a message - 'MESSAGE_REACTION_REMOVE' — User removed a reaction from a message - 'MESSAGE_REACTION_REMOVE_ALL' — All reactions were explicitly removed from a message - 'MESSAGE_REACTION_REMOVE_EMOJI' — All reactions for a given emoji were explicitly removed from a message - 'USER_UPDATE' — Properties about the user changed - 'ENTITLEMENT_CREATE' — Entitlement was created - 'ENTITLEMENT_UPDATE' — Entitlement was updated - 'ENTITLEMENT_DELETE' — Entitlement was deleted - 'READY' — Contains the initial state information - 'RESUMED' — Response to Resume - 'PRESENCE_UPDATE' — User was updated - 'VOICE_STATE_UPDATE' — Someone joined, left, or moved a voice channel - 'VOICE_SERVER_UPDATE' — Guild's voice server was updated - 'LOBBY_MESSAGE_CREATE' — Sent when a message is created in a lobby - 'LOBBY_MESSAGE_UPDATE' — Sent when a message is updated in a lobby - 'LOBBY_MESSAGE_DELETE' — Sent when a message is deleted from a lobby - 'GAME_DIRECT_MESSAGE_CREATE' — Sent when a direct message is created during an active Social SDK session - 'GAME_DIRECT_MESSAGE_DELETE' — Sent when a direct message is deleted during an active Social SDK session - 'GAME_DIRECT_MESSAGE_UPDATE' — Sent when a direct message is updated during an active Social SDK session - 'INTERACTION_CREATE' — User used an interaction, such as an Application Command - 'INTEGRATION_CREATE' — Guild integration was created - 'INTEGRATION_UPDATE' — Guild integration was updated - 'INTEGRATION_DELETE' — Guild integration was deleted - 'APPLICATION_COMMAND_PERMISSIONS_UPDATE' — Application command permission was updated - 'APPLICATION_AUTHORIZED' — Sent when an app was authorized by a user to a server or their account - 'APPLICATION_DEAUTHORIZED' — Sent when an app was deauthorized by a user - 'STAGE_INSTANCE_CREATE' — Stage instance was created - 'STAGE_INSTANCE_UPDATE' — Stage instance was updated - 'STAGE_INSTANCE_DELETE' — Stage instance was deleted or closed - 'GUILD_AUDIT_LOG_ENTRY_CREATE' — A guild audit log entry was created - 'GUILD_SCHEDULED_EVENT_CREATE' — Guild scheduled event was created - 'GUILD_SCHEDULED_EVENT_UPDATE' — Guild scheduled event was updated - 'GUILD_SCHEDULED_EVENT_DELETE' — Guild scheduled event was deleted - 'GUILD_SCHEDULED_EVENT_USER_ADD' — User subscribed to a guild scheduled event - 'GUILD_SCHEDULED_EVENT_USER_REMOVE' — User unsubscribed from a guild scheduled event - 'AUTO_MODERATION_RULE_CREATE' — Auto Moderation rule was created - 'AUTO_MODERATION_RULE_UPDATE' — Auto Moderation rule was updated - 'AUTO_MODERATION_RULE_DELETE' — Auto Moderation rule was deleted - 'AUTO_MODERATION_ACTION_EXECUTION' — Auto Moderation rule was triggered and an action was executed (.e.g. a message was blocked) - 'GUILD_SOUNDBOARD_SOUNDS_UPDATE' - 'GUILD_SOUNDBOARD_SOUND_CREATE' - 'GUILD_SOUNDBOARD_SOUND_UPDATE' - 'GUILD_SOUNDBOARD_SOUND_DELETE' - 'QUEST_USER_ENROLLMENT' — User was added to a Quest (currently unavailable) - 'RATE_LIMITED' - `explicit_content_filter` union, required - 0 — inherit guild content filter setting - 1 — interactions will always be scanned - `team` TeamResponse, required - `id` string, snowflake, required - `icon` string, nullable, required - `name` string, required - `owner_user_id` string, snowflake, required - `members` TeamMemberResponse[], required - `user` UserResponse, required - `id` string, snowflake, required - `username` string, required — the user's username, not unique across the platform - `avatar` string, nullable, required — the user's avatar hash - `discriminator` string, required — the user's Discord-tag - `public_flags` integer, required — the public flags on a user's account - `flags` integer, required - `bot` boolean — whether the user belongs to an OAuth2 application - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system) - `banner` string, nullable — the user's banner hash - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code - `global_name` string, nullable, required — the user's display name, if it is set - `avatar_decoration_data` UserAvatarDecorationResponse - `asset` string, required — the avatar decoration hash - `sku_id` string, snowflake, required - `collectibles` UserCollectiblesResponse - `nameplate` UserNameplateResponse, required - `sku_id` string, snowflake, required - `asset` string, required — Path to the nameplate asset - `label` string, required — The label of this nameplate. Currently unused - `palette` union, required - … - `primary_guild` UserPrimaryGuildResponse, required - `identity_guild_id` string, snowflake, required - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters - `badge` string, nullable, required — the server tag badge hash - `team_id` string, snowflake, required - `membership_state` union, required - 1 — User has been invited to the team. - 2 — User has accepted the team invitation. - `role` union, required - 'admin' — Admins have similar access as owners, except they cannot take destructive actions on the team or team-owned apps. - 'developer' — Developers can access information about team-owned apps, like the client secret or public key. They can also take limited actions on team-owned apps, like configuring interaction endpoints or resetting the bot token. Members with the Developer role cannot manage the team or its members, or take destructive actions on team-owned apps. - 'read_only' — Read-only members can access information about a team and any team-owned apps. Some examples include getting the IDs of applications and exporting payout records. Members can also invite bots associated with team-owned apps that are marked private. - `permissions` string[], required - `eligible_oauth2_scopes` OAuth2Scopes[], required - union - 'identify' — allows /users/@me without email - 'email' — enables /users/@me to return an email - 'connections' — allows /users/@me/connections to return linked third-party accounts - 'guilds' — allows /users/@me/guilds to return basic information about all of a user's guilds - 'guilds.join' — allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild - 'guilds.members.read' — allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild - 'gdm.join' — allows your app to join users to a group dm - 'bot' — for oauth2 bots, this puts the bot in the user's selected guild by default - 'rpc' — for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval - 'rpc.notifications.read' — for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval - 'rpc.voice.read' — for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval - 'rpc.voice.write' — for local rpc server access, this allows you to update a user's voice settings - requires Discord approval - 'rpc.video.read' — for local rpc server access, this allows you to read a user's video status - requires Discord approval - 'rpc.video.write' — for local rpc server access, this allows you to update a user's video settings - requires Discord approval - 'rpc.screenshare.read' — for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval - 'rpc.screenshare.write' — for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval - 'rpc.activities.write' — for local rpc server access, this allows you to update a user's activity - requires Discord approval - 'webhook.incoming' — this generates a webhook that is returned in the oauth token response for authorization code grants - 'messages.read' — for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates) - 'applications.builds.upload' — allows your app to upload/update builds for a user's applications - requires Discord approval - 'applications.builds.read' — allows your app to read build data for a user's applications - 'applications.commands' — allows your app to use commands in a guild - 'applications.commands.permissions.update' — allows your app to update permissions for its commands in a guild a user has permissions to - 'applications.commands.update' — allows your app to update its commands using a Bearer token - client credentials grant only - 'applications.store.update' — allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications - 'applications.entitlements' — allows your app to read entitlements for a user's applications - 'activities.read' — allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval - 'activities.write' — allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER) - 'activities.invites.write' — allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER) - 'relationships.read' — allows your app to know a user's friends and implicit relationships - requires Discord approval - 'voice' — allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval - 'dm_channels.read' — allows your app to see information about the user's DMs and group DMs - requires Discord approval - 'role_connections.write' — allows your app to update a user's connection and metadata for the app - 'openid' — for OpenID Connect, this allows your app to receive user id and basic profile information ## Other responses - `429` — Client ratelimited response - `4XX` — Client error response --- [API](https://skmtc.net/discord/apis/discord-http-api-preview.md) · [All operations](https://skmtc.net/discord/apis/discord-http-api-preview/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/discord/discord-http-api-preview/versions/f6cd197cbe47/schema)