Skip to content

Commit 16b24b0

Browse files
author
Slack API Ref Buildbot
committed
Updated from Slack docs, 2026/04/17
1 parent 8a1fe4a commit 16b24b0

5 files changed

Lines changed: 166 additions & 0 deletions

File tree

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
{
2+
"desc": "Sets the app icon",
3+
"http_method": "POST",
4+
"scope": {
5+
"user": [
6+
"app_configurations:write"
7+
]
8+
},
9+
"rate_limits": "t1",
10+
"json_input_supported": true,
11+
"args": {
12+
"type": "object",
13+
"required": [
14+
"token",
15+
"app_id"
16+
],
17+
"properties": {
18+
"token": {
19+
"desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.",
20+
"type": "string",
21+
"subtype": "auth",
22+
"example": "xxxx-xxxxxxxxx-xxxx"
23+
},
24+
"app_id": {
25+
"desc": "The ID of the app whose icon you want to set.",
26+
"schema": "app_id"
27+
},
28+
"file": {
29+
"desc": "File contents via `multipart/form-data`",
30+
"schema": "post_file",
31+
"is_resource": false
32+
},
33+
"url": {
34+
"desc": "URL of a publicly hosted image",
35+
"type": "string",
36+
"maxLength": 3000
37+
}
38+
}
39+
},
40+
"output": null,
41+
"errors": {
42+
"error_bad_format": {
43+
"desc": "Icon must be a valid image file."
44+
},
45+
"invalid_app": {
46+
"desc": "App does not exist."
47+
},
48+
"invalid_app_id": {
49+
"desc": "App ID is not valid."
50+
},
51+
"invalid_icon_size": {
52+
"desc": "Icon dimensions must be between 512x512px and 2000x2000px."
53+
},
54+
"invalid_parameters": {
55+
"desc": "Only one of `URL` or `file` can be defined."
56+
},
57+
"missing_arguments": {
58+
"desc": "One of `URL` or `file` must be provided."
59+
},
60+
"no_permission": {
61+
"desc": "User does not have required permissions for app."
62+
},
63+
"unable_to_open_file": {
64+
"desc": "Error with file upload."
65+
}
66+
},
67+
"examples": {
68+
"success": {
69+
"url": "/api/apps.icon.set",
70+
"description": "Typical success response",
71+
"example": {
72+
"ok": true
73+
}
74+
},
75+
"error": {
76+
"url": "/api/apps.icon.set",
77+
"description": "Typical error response if invalid icon size",
78+
"example": {
79+
"ok": false,
80+
"error": "invalid_icon_size"
81+
}
82+
}
83+
}
84+
}

docs.slack.dev/methods/apps.manifest.create.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
"manifest": {
2525
"type": "string",
2626
"desc": "A JSON app manifest encoded as a string. This manifest **must** use a valid [app manifest schema - read our guide to creating one](/app-manifests/configuring-apps-with-app-manifests#fields)."
27+
},
28+
"team_id": {
29+
"schema": "workspace_id",
30+
"type": "string",
31+
"desc": "When called with an org token, which specific team to create app on"
2732
}
2833
}
2934
},

docs.slack.dev/methods/methods.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -846,6 +846,13 @@
846846
"apps"
847847
]
848848
},
849+
{
850+
"name": "apps.icon.set",
851+
"description": "Sets the app icon",
852+
"family": [
853+
"apps"
854+
]
855+
},
849856
{
850857
"name": "apps.manifest.create",
851858
"description": "Create an app from an app manifest.",

methods/apps/apps.icon.set.json

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{
2+
"group": "apps",
3+
"name": "apps.icon.set",
4+
"deprecated": false,
5+
"desc": "Sets the app icon",
6+
"args": {
7+
"app_id": {
8+
"required": true,
9+
"desc": "The ID of the app whose icon you want to set."
10+
},
11+
"file": {
12+
"required": false,
13+
"desc": "File contents via multipart/form-data.",
14+
"type": "file"
15+
},
16+
"url": {
17+
"required": false,
18+
"desc": "URL of a publicly hosted image.",
19+
"type": "string"
20+
}
21+
},
22+
"response": {
23+
"examples": [
24+
"{\n \"ok\": true\n}",
25+
"{\n \"ok\": false,\n \"error\": \"invalid_icon_size\"\n}"
26+
]
27+
},
28+
"errors": {
29+
"access_denied": "Access to a resource specified in the request is denied.",
30+
"accesslimited": "Access to this method is limited on the current network.",
31+
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
32+
"deprecated_endpoint": "The endpoint has been deprecated.",
33+
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
34+
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
35+
"error_bad_format": "Icon must be a valid image file.",
36+
"fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
37+
"invalid_app": "App does not exist.",
38+
"invalid_app_id": "App ID is not valid.",
39+
"invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
40+
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
41+
"invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.",
42+
"invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.",
43+
"invalid_icon_size": "Icon dimensions must be between 512x512px and 2000x2000px.",
44+
"invalid_parameters": "Only one of `URL` or `file` can be defined.",
45+
"invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.",
46+
"is_bot": "This method cannot be called by a legacy bot.",
47+
"method_deprecated": "The method has been deprecated.",
48+
"missing_arguments": "One of `URL` or `file` must be provided.",
49+
"missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.",
50+
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
51+
"no_permission": "User does not have required permissions for app.",
52+
"not_allowed_token_type": "The token type used in this request is not allowed.",
53+
"not_authed": "No authentication token provided.",
54+
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
55+
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
56+
"request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
57+
"service_unavailable": "The service is temporarily unavailable.",
58+
"team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.",
59+
"token_expired": "Authentication token has expired.",
60+
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.",
61+
"two_factor_setup_required": "Two factor setup is required.",
62+
"unable_to_open_file": "Error with file upload.",
63+
"unknown_method": "This method is currently not available."
64+
}
65+
}

methods/apps/apps.manifest.create.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
"desc": "A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one.",
1010
"type": "string",
1111
"format": "json"
12+
},
13+
"team_id": {
14+
"required": false,
15+
"desc": "When called with an org token, which specific team to create app on.",
16+
"type": "string"
1217
}
1318
},
1419
"response": {

0 commit comments

Comments
 (0)