Skip to content

Commit 860ab16

Browse files
author
Slack API Ref Buildbot
committed
Updated from Slack docs, 2025/09/06
1 parent 37d0464 commit 860ab16

File tree

314 files changed

+2533
-11670
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

314 files changed

+2533
-11670
lines changed

groups/admin.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"name": "admin"
3+
}

groups/assistant.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"name": "assistant"
3+
}

groups/lists.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"name": "lists"
3+
}

groups/openid.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"name": "openid"
3+
}

groups/tooling.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"name": "tooling"
3+
}

methods/admin/admin.analytics.getFile.json

Lines changed: 21 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -4,73 +4,46 @@
44
"deprecated": false,
55
"desc": "Retrieve analytics data for a given date, presented as a compressed JSON file",
66
"args": {
7-
"type": {
8-
"required": true,
9-
"example": "member",
10-
"desc": "The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).",
11-
"type": "string"
12-
},
137
"date": {
148
"required": false,
159
"example": "2020-09-01",
16-
"desc": "Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC. Required unless metadata_only is set to true.",
10+
"desc": "Date to retrieve the analytics data for, expressed as `YYYY-MM-DD` in UTC. Required unless `metadata_only` is set to true.",
1711
"type": "date"
1812
},
1913
"metadata_only": {
2014
"required": false,
21-
"example": "false",
22-
"desc": "Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.",
15+
"example": "true",
16+
"desc": "Retrieve metadata for the `type` of analytics indicated. Can be used only with `type` set to `public_channel` analytics. See [detail below](#metadata_only). Omit the `date` parameter when using this argument.",
2317
"type": "boolean"
18+
},
19+
"type": {
20+
"required": true,
21+
"example": "member",
22+
"desc": "The type of analytics to retrieve. The options are currently limited to `member` (for Enterprise org member analytics) and `public_channel` (for public channel analytics).",
23+
"type": "string"
2424
}
2525
},
2626
"response": {
2727
"examples": [
28+
"\"\"",
2829
"{\n \"ok\": false,\n \"error\": \"org_level_email_display_disabled\"\n}"
2930
]
3031
},
3132
"errors": {
32-
"data_not_available": "The date was before the API became available.",
33+
"data_not_available": "The `date` was before the API became available.",
3334
"feature_not_available": "The user token does not belong to an Enterprise or Business+ team.",
3435
"feature_not_enabled": "This feature is not enabled on your workspace.",
35-
"file_not_found": "The analytics data for the date specified weren't found.",
36-
"file_not_yet_available": "The analytics data for the date isn't available yet.",
37-
"invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.",
38-
"invalid_date": "The date argument was invalid.",
39-
"invalid_type": "The analytics data for the type specified weren't found.",
36+
"file_not_found": "The analytics data for the `date` specified weren't found.",
37+
"file_not_yet_available": "The analytics data for the `date` isn't available yet.",
38+
"invalid_arguments": "Arguments weren't fully provided. For example, the `date` argument wasn't passed.",
39+
"invalid_date": "The `date` argument was invalid.",
40+
"invalid_type": "The analytics data for the `type` specified weren't found.",
4041
"member_analytics_disabled": "Member analytics are disabled for your organization.",
41-
"metadata_not_available": "Metadata not available for the analytics type you provided.",
42-
"metadata_only_does_not_support_date": "The metadata_only field gets the latest metadata file. The date field is not supported.",
43-
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
42+
"metadata_not_available": "Metadata not available for the analytics `type` you provided.",
43+
"metadata_only_does_not_support_date": "The `metadata_only` field gets the latest metadata file. The `date` field is not supported.",
44+
"missing_scope": "This token doesn't have the scope required.",
4445
"not_an_admin": "The user token does not have admin privileges.",
45-
"org_level_email_display_disabled": "This API is unavailable for organizations with a 'Hide email addresses' policy.",
46-
"user_cannot_manage_public_channels": "The user must have permissions to manage public channels at the Enterprise level.",
47-
"access_denied": "Access to a resource specified in the request is denied.",
48-
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
49-
"deprecated_endpoint": "The endpoint has been deprecated.",
50-
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
51-
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
52-
"invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.",
53-
"is_bot": "This method cannot be called by a legacy bot.",
54-
"method_deprecated": "The method has been deprecated.",
55-
"not_allowed_token_type": "The token type used in this request is not allowed.",
56-
"not_authed": "No authentication token provided.",
57-
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
58-
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration 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-
"accesslimited": "Access to this method is limited on the current network.",
63-
"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.",
64-
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.",
65-
"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.",
66-
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
67-
"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.",
68-
"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.",
69-
"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.",
70-
"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.",
71-
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
72-
"request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
73-
"service_unavailable": "The service is temporarily unavailable.",
74-
"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."
46+
"org_level_email_display_disabled": "This API is unavailable for organizations with a _'Hide email addresses'_ policy.",
47+
"user_cannot_manage_public_channels": "The user must have permissions to manage public channels at the Enterprise level."
7548
}
7649
}

methods/admin/admin.apps.activities.list.json

Lines changed: 8 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@
1212
"component_id": {
1313
"required": false,
1414
"example": "Wf013SMGL4V9",
15-
"desc": "The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for worflows.",
15+
"desc": "The component ID of log events to be returned. Will be `FnXXXXXX` for functions, and `WfXXXXXX` for workflows.",
1616
"type": "string"
1717
},
1818
"component_type": {
1919
"required": false,
2020
"example": "workflows",
21-
"desc": "The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.",
21+
"desc": "The component type of log events to be returned. Acceptable values are `events_api`, `workflows`, `functions` and `tables`.",
2222
"type": "string"
2323
},
2424
"cursor": {
2525
"required": false,
2626
"example": "bG9nX2lkOjc5NjQ1NA==",
27-
"desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. See pagination for more detail.",
27+
"desc": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. See [pagination](/apis/web-api/pagination) for more detail.",
2828
"type": "string"
2929
},
3030
"limit": {
@@ -54,7 +54,7 @@
5454
"min_log_level": {
5555
"required": false,
5656
"example": "info",
57-
"desc": "The minimum log level of the log events to be returned. Defaults to info. Acceptable values (in order of relative importance from smallest to largest) are trace, debug, info, warn, error and fatal.",
57+
"desc": "The minimum log level of the log events to be returned. Defaults to `info`. Acceptable values (in order of relative importance from smallest to largest) are `trace`, `debug`, `info`, `warn`, `error` and `fatal`.",
5858
"type": "string"
5959
},
6060
"sort_direction": {
@@ -66,7 +66,7 @@
6666
"source": {
6767
"required": false,
6868
"example": "slack",
69-
"desc": "The source of log events to be returned. Acceptable values are slack and developer.",
69+
"desc": "The source of log events to be returned. Acceptable values are `slack` and `developer`.",
7070
"type": "string"
7171
},
7272
"team_id": {
@@ -88,40 +88,11 @@
8888
]
8989
},
9090
"errors": {
91-
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.",
91+
"internal_error": "Something went wrong on our end, please try again.",
9292
"invalid_app_id": "App ID provided is not valid.",
9393
"invalid_app": "App ID provided is not valid for team and user.",
9494
"invalid_args": "Required arguments either were not provided or contain invalid values.",
95-
"invalid_cursor": "Value passed for cursor was not valid or is no longer valid.",
96-
"invalid_team": "Team ID provided is not valid.",
97-
"access_denied": "Access to a resource specified in the request is denied.",
98-
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
99-
"deprecated_endpoint": "The endpoint has been deprecated.",
100-
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
101-
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
102-
"invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.",
103-
"is_bot": "This method cannot be called by a legacy bot.",
104-
"method_deprecated": "The method has been deprecated.",
105-
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
106-
"not_allowed_token_type": "The token type used in this request is not allowed.",
107-
"not_authed": "No authentication token provided.",
108-
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
109-
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
110-
"token_expired": "Authentication token has expired.",
111-
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.",
112-
"two_factor_setup_required": "Two factor setup is required.",
113-
"accesslimited": "Access to this method is limited on the current network.",
114-
"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.",
115-
"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.",
116-
"invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.",
117-
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
118-
"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.",
119-
"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.",
120-
"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.",
121-
"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.",
122-
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
123-
"request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
124-
"service_unavailable": "The service is temporarily unavailable.",
125-
"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."
95+
"invalid_cursor": "Value passed for `cursor` was not valid or is no longer valid.",
96+
"invalid_team": "Team ID provided is not valid"
12697
}
12798
}

0 commit comments

Comments
 (0)