Skip to content

Commit 67cdccf

Browse files
shaydewaelLulalaby
shaydewael
and
Lulalaby
committed
Update Application Endpoints (discord#6297)
* update application endpoints * make bot optional * uh * add back approximate_guild_count * aaa * Update docs/resources/Application.md Co-authored-by: Lala Sabathil <[email protected]> * Update docs/resources/Application.md Co-authored-by: Lala Sabathil <[email protected]> * TABLES * tag characters --------- Co-authored-by: Lala Sabathil <[email protected]>
1 parent 382f629 commit 67cdccf

File tree

1 file changed

+58
-30
lines changed

1 file changed

+58
-30
lines changed

‎docs/resources/Application.md‎

Lines changed: 58 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,35 @@
44

55
###### Application Structure
66

7-
| Field | Type | Description |
8-
|------------------------------------|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
9-
| id | snowflake | the id of the app |
10-
| name | string | the name of the app |
11-
| icon | ?string | the [icon hash](#DOCS_REFERENCE/image-formatting) of the app |
12-
| description | string | the description of the app |
13-
| rpc_origins? | array of strings | an array of rpc origin urls, if rpc is enabled |
14-
| bot_public | boolean | when false only app owner can join the app's bot to guilds |
15-
| bot_require_code_grant | boolean | when true the app's bot will only join upon completion of the full oauth2 code grant flow |
16-
| terms_of_service_url? | string | the url of the app's terms of service |
17-
| privacy_policy_url? | string | the url of the app's privacy policy |
18-
| owner? | partial [user](#DOCS_RESOURCES_USER/user-object) object | partial user object containing info on the owner of the application |
19-
| summary *(deprecated)* | string | **deprecated and will be removed in v11.** An empty string. |
20-
| verify_key | string | the hex encoded key for verification in interactions and the GameSDK's [GetTicket](#DOCS_GAME_SDK_APPLICATIONS/getticket) |
21-
| team | ?[team](#DOCS_TOPICS_TEAMS/data-models-team-object) object | if the application belongs to a team, this will be a list of the members of that team |
22-
| guild_id? | snowflake | guild associated with the app. For example, a developer support server. |
23-
| guild? | partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object | a partial object of the associated guild |
24-
| primary_sku_id? | snowflake | if this application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists |
25-
| slug? | string | if this application is a game sold on Discord, this field will be the URL slug that links to the store page |
26-
| cover_image? | string | the application's default rich presence invite [cover image hash](#DOCS_REFERENCE/image-formatting) |
27-
| flags? | integer | the application's public [flags](#DOCS_RESOURCES_APPLICATION/application-object-application-flags) |
28-
| approximate_guild_count? | integer | an approximate count of the app's guild membership. |
29-
| tags? | array of strings | up to 5 tags describing the content and functionality of the application |
30-
| install_params? | [install params](#DOCS_RESOURCES_APPLICATION/install-params-object) object | settings for the application's default in-app authorization link, if enabled |
31-
| custom_install_url? | string | the application's default custom authorization link, if enabled |
32-
| role_connections_verification_url? | string | the application's role connection verification entry point, which when configured will render the app as a verification method in the guild role verification configuration |
7+
| Field | Type | Description |
8+
|------------------------------------|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
9+
| id | snowflake | ID of the app |
10+
| name | string | Name of the app |
11+
| icon | ?string | [Icon hash](#DOCS_REFERENCE/image-formatting) of the app |
12+
| description | string | Description of the app |
13+
| rpc_origins? | array of strings | List of RPC origin URLs, if RPC is enabled |
14+
| bot_public | boolean | When `false`, only the app owner can add the app to guilds |
15+
| bot_require_code_grant | boolean | When `true`, the app's bot will only join upon completion of the full OAuth2 code grant flow |
16+
| bot? | partial [user](#DOCS_RESOURCES_USER/user-object) object | Partial user object for the bot user associated with the app |
17+
| terms_of_service_url? | string | URL of the app's Terms of Service |
18+
| privacy_policy_url? | string | URL of the app's Privacy Policy |
19+
| owner? | partial [user](#DOCS_RESOURCES_USER/user-object) object | Partial user object for the owner of the app |
20+
| summary *(deprecated)* | string | **deprecated and will be removed in v11.** An empty string. |
21+
| verify_key | string | Hex encoded key for verification in interactions and the GameSDK's [GetTicket](#DOCS_GAME_SDK_APPLICATIONS/getticket) |
22+
| team | ?[team](#DOCS_TOPICS_TEAMS/data-models-team-object) object | If the app belongs to a team, this will be a list of the members of that team |
23+
| guild_id? | snowflake | Guild associated with the app. For example, a developer support server. |
24+
| guild? | partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object | Partial object of the associated guild |
25+
| primary_sku_id? | snowflake | If this app is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists |
26+
| slug? | string | If this app is a game sold on Discord, this field will be the URL slug that links to the store page |
27+
| cover_image? | string | App's default rich presence invite [cover image hash](#DOCS_REFERENCE/image-formatting) |
28+
| flags? | integer | App's public [flags](#DOCS_RESOURCES_APPLICATION/application-object-application-flags) |
29+
| approximate_guild_count? | integer | Approximate count of guilds the app has been added to |
30+
| redirect_uris? | array of strings | Array of redirect URIs for the app |
31+
| interactions_endpoint_url? | string | [Interactions endpoint URL](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/receiving-an-interaction) for the app |
32+
| role_connections_verification_url? | string | Role connection verification URL for the app |
33+
| tags? | array of strings | List of tags describing the content and functionality of the app. Max of 5 tags. |
34+
| install_params? | [install params](#DOCS_RESOURCES_APPLICATION/install-params-object) object | Settings for the app's default in-app authorization link, if enabled |
35+
| custom_install_url? | string | Default custom authorization URL for the app, if enabled |
3336

3437
###### Example Application Object
3538

@@ -93,11 +96,36 @@
9396

9497
###### Install Params Structure
9598

96-
| Field | Type | Description |
97-
|-------------|------------------|------------------------------------------------------------------------------------------------------------|
98-
| scopes | array of strings | the [scopes](#DOCS_TOPICS_OAUTH2/shared-resources-oauth2-scopes) to add the application to the server with |
99-
| permissions | string | the [permissions](#DOCS_TOPICS_PERMISSIONS) to request for the bot role |
99+
| Field | Type | Description |
100+
|-------------|------------------|--------------------------------------------------------------------------------------------------------|
101+
| scopes | array of strings | [Scopes](#DOCS_TOPICS_OAUTH2/shared-resources-oauth2-scopes) to add the application to the server with |
102+
| permissions | string | [Permissions](#DOCS_TOPICS_PERMISSIONS) to request for the bot role |
100103

101104
## Get Current Application % GET /applications/@me
102105

103106
Returns the [application](#DOCS_RESOURCES_APPLICATION/application-object) object associated with the requesting bot user.
107+
108+
## Edit Current Application % PATCH /applications/@me
109+
110+
Edit properties of the app associated with the requesting bot user. Only properties that are passed will be updated. Returns the updated [application](#DOCS_RESOURCES_APPLICATION/application-object) object on success.
111+
112+
> info
113+
> All parameters to this endpoint are optional
114+
115+
###### JSON Params
116+
117+
| Field | Type | Description |
118+
|-----------------------------------|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
119+
| custom_install_url | string | Default custom authorization URL for the app, if enabled |
120+
| description | string | Description of the app |
121+
| role_connections_verification_url | string | Role connection verification URL for the app |
122+
| install_params | [install params](#DOCS_RESOURCES_APPLICATION/install-params-object) object | Settings for the app's default in-app authorization link, if enabled |
123+
| flags \* | integer | App's public [flags](#DOCS_RESOURCES_APPLICATION/application-object-application-flags) |
124+
| icon | ?[image data](#DOCS_REFERENCE/image-data) | Icon for the app |
125+
| cover_image | ?[image data](#DOCS_REFERENCE/image-data) | Default rich presence invite cover image for the app |
126+
| interactions_endpoint_url \*\* | string | [Interactions endpoint URL](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/receiving-an-interaction) for the app |
127+
| tags | array of strings | List of tags describing the content and functionality of the app (max of 20 characters per tag). Max of 5 tags. |
128+
129+
\* Only limited intent flags (`GATEWAY_PRESENCE_LIMITED`, `GATEWAY_GUILD_MEMBERS_LIMITED`, and `GATEWAY_MESSAGE_CONTENT_LIMITED`) can be updated via the API.
130+
131+
\*\* To update an Interactions endpoint URL via the API, the URL must be valid according to the [Receiving an Interaction](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/receiving-an-interaction) documentation.

0 commit comments

Comments
 (0)