admin_apps_approve | Approve an app for installation on a workspace. |
|
Action options:
-t, --team_id [team_id]
team_id
Required: no
-a, --app_id [app_id]
The id of the app to approve.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.apps:write`
Required: yes
-r, --request_id [request_id]
The id of the request to approve.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_apps_approved_list | List approved apps for an org or workspace. |
|
Action options:
-t, --team_id [team_id]
team_id
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.apps:read`
Required: yes
-e, --enterprise_id [enterprise_id]
enterprise_id
Required: no
-l, --limit [limit]
The maximum number of items to return. Must be between 1 - 1000 both inclusive.
Required: no
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_apps_requests_list | List app requests for a team/workspace. |
|
Action options:
-l, --limit [limit]
The maximum number of items to return. Must be between 1 - 1000 both inclusive.
Required: no
-t, --token <token>
Authentication token. Requires scope: `admin.apps:read`
Required: yes
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
Required: no
-u, --team_id [team_id]
team_id
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_apps_restrict | Restrict an app for installation on a workspace. |
|
Action options:
-t, --team_id [team_id]
team_id
Required: no
-r, --request_id [request_id]
The id of the request to restrict.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.apps:write`
Required: yes
-a, --app_id [app_id]
The id of the app to restrict.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_apps_restricted_list | List restricted apps for an org or workspace. |
|
Action options:
-e, --enterprise_id [enterprise_id]
enterprise_id
Required: no
-t, --token <token>
Authentication token. Requires scope: `admin.apps:read`
Required: yes
-l, --limit [limit]
The maximum number of items to return. Must be between 1 - 1000 both inclusive.
Required: no
-u, --team_id [team_id]
team_id
Required: no
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_archive | Archive a public or private channel. |
|
Action options:
-c, --channel_id <channel_id>
The channel to archive.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_converttoprivate | Convert a public channel to a private channel. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-c, --channel_id <channel_id>
The channel to convert to private.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_create | Create a public or private channel-based conversation. |
|
Action options:
-o, --org_wide [org_wide]
When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel
Required: no
Permitted values: false, true
-d, --description [description]
Description of the public or private channel to create.
Required: no
-n, --name <name>
Name of the public or private channel to create.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-i, --is_private <is_private>
When `true`, creates a private channel instead of a public channel
Required: yes
Permitted values: false, true
-u, --team_id [team_id]
The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`.
Required: no
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_delete | Delete a public or private channel. |
|
Action options:
-c, --channel_id <channel_id>
The channel to delete.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_disconnectshared | Disconnect a connected channel from one or more workspaces. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-c, --channel_id <channel_id>
The channel to be disconnected from some workspaces.
Required: yes
-l, --leaving_team_ids [leaving_team_ids]
The team to be removed from the channel. Currently only a single team id can be specified.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_ekm_listoriginalconnectedchannelinfo | List all disconnected channels... |
|
Action options:
-l, --limit [limit]
The maximum number of items to return. Must be between 1 - 1000 both inclusive.
Required: no
-t, --team_ids [team_ids]
A comma-separated list of the workspaces to which the channels you would like returned belong.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.conversations:read`
Required: yes
-c, --channel_ids [channel_ids]
A comma-separated list of channels to filter to.
Required: no
-d, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_getconversationprefs | Get conversation preferences for a public or private channel. |
|
Action options:
-c, --channel_id <channel_id>
The channel to get preferences for.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:read`
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_getteams | Get all the workspaces a given public or private channel is connected to wi... |
|
Action options:
-c, --channel_id <channel_id>
The channel to determine connected workspaces within the organization for.
Required: yes
-l, --limit [limit]
The maximum number of items to return. Must be between 1 - 1000 both inclusive.
Required: no
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:read`
Required: yes
-d, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_invite | Invite a user to a public or private channel. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-u, --user_ids <user_ids>
The users to invite.
Required: yes
-c, --channel_id <channel_id>
The channel that the users will be invited to.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_rename | Rename a public or private channel. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-n, --name <name>
name
Required: yes
-c, --channel_id <channel_id>
The channel to rename.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_restrictaccess_addgroup | Add an allowlist of IDP groups for accessing a channel |
|
Action options:
-g, --group_id <group_id>
The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for the private channel.
Required: yes
-c, --channel_id <channel_id>
The channel to link this group to.
Required: yes
-t, --team_id [team_id]
The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_restrictaccess_listgroups | List all IDP Groups linked to a channel |
|
Action options:
-t, --team_id [team_id]
The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.conversations:read`
Required: yes
-c, --channel_id <channel_id>
channel_id
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_restrictaccess_removegroup | Remove a linked IDP group linked from a private channel |
|
Action options:
-t, --team_id <team_id>
The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-c, --channel_id <channel_id>
The channel to remove the linked group from.
Required: yes
-g, --group_id <group_id>
The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to remove from the private channel.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_search | Search for public or private channels in an Enterprise organization. |
|
Action options:
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
Required: no
-q, --query [query]
Name of the the channel to query by.
Required: no
-s, --sort [sort]
Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted
Required: no
-t, --team_ids [team_ids]
Comma separated string of team IDs, signifying the workspaces to search through.
Required: no
-u, --search_channel_types [search_channel_types]
The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).
Required: no
-v, --token <token>
Authentication token. Requires scope: `admin.conversations:read`
Required: yes
-w, --sort_dir [sort_dir]
Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)
Required: no
-l, --limit [limit]
Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.
Required: no
-x, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-y, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_setconversationprefs | Set the posting permissions for a public or private channel. |
|
Action options:
-p, --prefs <prefs>
The prefs for this channel in a stringified JSON format.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-c, --channel_id <channel_id>
The channel to set the prefs for
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_setteams | Set the workspaces in an Enterprise grid org that connect to a public or pr... |
|
Action options:
-c, --channel_id <channel_id>
The encoded `channel_id` to add or remove to workspaces.
Required: yes
-t, --team_id [team_id]
The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-v, --target_team_ids [target_team_ids]
A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.
Required: no
-o, --org_channel [org_channel]
True if channel has to be converted to an org channel
Required: no
Permitted values: false, true
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_conversations_unarchive | Unarchive a public or private channel. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.conversations:write`
Required: yes
-c, --channel_id <channel_id>
The channel to unarchive.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_emoji_add | Add an emoji. |
|
Action options:
-n, --name <name>
The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-u, --url <url>
The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_emoji_addalias | Add an emoji alias. |
|
Action options:
-a, --alias_for <alias_for>
The alias of the emoji.
Required: yes
-n, --name <name>
The name of the emoji to be aliased. Colons (`:myemoji:`) around the value are not required, although they may be included.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_emoji_list | List emoji for an Enterprise Grid organization. |
|
Action options:
-l, --limit [limit]
The maximum number of items to return. Must be between 1 - 1000 both inclusive.
Required: no
-t, --token <token>
Authentication token. Requires scope: `admin.teams:read`
Required: yes
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_emoji_remove | Remove an emoji across an Enterprise Grid organization |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-n, --name <name>
The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_emoji_rename | Rename an emoji. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-n, --new_name <new_name>
The new name of the emoji.
Required: yes
-o, --name <name>
The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_inviterequests_approve | Approve a workspace invite request. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.invites:write`
Required: yes
-u, --team_id [team_id]
ID for the workspace where the invite request was made.
Required: no
-i, --invite_request_id <invite_request_id>
ID of the request to invite.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_inviterequests_approved_list | List all approved workspace invite requests. |
|
Action options:
-c, --cursor [cursor]
Value of the `next_cursor` field sent as part of the previous API response
Required: no
-l, --limit [limit]
The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
Required: no
-t, --team_id [team_id]
ID for the workspace where the invite requests were made.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.invites:read`
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_inviterequests_denied_list | List all denied workspace invite requests. |
|
Action options:
-l, --limit [limit]
The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive
Required: no
-c, --cursor [cursor]
Value of the `next_cursor` field sent as part of the previous api response
Required: no
-t, --team_id [team_id]
ID for the workspace where the invite requests were made.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.invites:read`
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_inviterequests_deny | Deny a workspace invite request. |
|
Action options:
-i, --invite_request_id <invite_request_id>
ID of the request to invite.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `admin.invites:write`
Required: yes
-u, --team_id [team_id]
ID for the workspace where the invite request was made.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_inviterequests_list | List all pending workspace invite requests. |
|
Action options:
-l, --limit [limit]
The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
Required: no
-t, --team_id [team_id]
ID for the workspace where the invite requests were made.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.invites:read`
Required: yes
-c, --cursor [cursor]
Value of the `next_cursor` field sent as part of the previous API response
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_admins_list | List all of the admins on a given workspace. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.teams:read`
Required: yes
-l, --limit [limit]
The maximum number of items to return.
Required: no
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
Required: no
-u, --team_id <team_id>
team_id
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_create | Create an Enterprise team. |
|
Action options:
-t, --team_name <team_name>
Team name (for example, Slack Softball Team).
Required: yes
-u, --team_domain <team_domain>
Team domain (for example, slacksoftballteam).
Required: yes
-v, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-w, --team_description [team_description]
Description for the team.
Required: no
-x, --team_discoverability [team_discoverability]
Who can join the team. A team's discoverability can be `open`, `closed`, `invite_only`, or `unlisted`.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_list | List all teams on an Enterprise organization |
|
Action options:
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
Required: no
-t, --token <token>
Authentication token. Requires scope: `admin.teams:read`
Required: yes
-l, --limit [limit]
The maximum number of items to return. Must be between 1 - 100 both inclusive.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_owners_list | List all of the owners on a given workspace. |
|
Action options:
-t, --team_id <team_id>
team_id
Required: yes
-l, --limit [limit]
The maximum number of items to return. Must be between 1 - 1000 both inclusive.
Required: no
-u, --token <token>
Authentication token. Requires scope: `admin.teams:read`
Required: yes
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_settings_info | Fetch information about settings in a workspace |
|
Action options:
-t, --team_id <team_id>
team_id
Required: yes
-u, --token <token>
Authentication token. Requires scope: `admin.teams:read`
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_settings_setdefaultchannels | Set the default channels of a workspace. |
|
Action options:
-c, --channel_ids <channel_ids>
An array of channel IDs.
Required: yes
-t, --team_id <team_id>
ID for the workspace to set the default channel for.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_settings_setdescription | Set the description of a given workspace. |
|
Action options:
-t, --team_id <team_id>
ID for the workspace to set the description for.
Required: yes
-d, --description <description>
The new description for the workspace.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_settings_setdiscoverability | An API method that allows admins to set the discoverability of a given work... |
|
Action options:
-d, --discoverability <discoverability>
This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`.
Required: yes
-t, --team_id <team_id>
The ID of the workspace to set discoverability on.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_settings_seticon | Sets the icon of a workspace. |
|
Action options:
-t, --team_id <team_id>
ID for the workspace to set the icon for.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-i, --image_url <image_url>
Image URL for the icon
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_teams_settings_setname | Set the name of a given workspace. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-n, --name <name>
The new name of the workspace.
Required: yes
-u, --team_id <team_id>
ID for the workspace to set the name for.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_usergroups_addchannels | Add one or more default channels to an IDP group. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.usergroups:write`
Required: yes
-u, --team_id [team_id]
The workspace to add default channels in.
Required: no
-v, --usergroup_id <usergroup_id>
ID of the IDP group to add default channels for.
Required: yes
-c, --channel_ids <channel_ids>
Comma separated string of channel IDs.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_usergroups_addteams | Associate one or more default workspaces with an organization... |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.teams:write`
Required: yes
-a, --auto_provision [auto_provision]
When `true`, this method automatically creates new workspace accounts for the IDP group members.
Required: no
Permitted values: false, true
-u, --team_ids <team_ids>
A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token.
Required: yes
-v, --usergroup_id <usergroup_id>
An encoded usergroup (IDP Group) ID.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_usergroups_listchannels | List the channels linked to an org-level IDP group (user group). |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.usergroups:read`
Required: yes
-u, --team_id [team_id]
ID of the the workspace.
Required: no
-i, --include_num_members [include_num_members]
Flag to include or exclude the count of members per channel.
Required: no
Permitted values: false, true
-v, --usergroup_id <usergroup_id>
ID of the IDP group to list default channels for.
Required: yes
-w, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_usergroups_removechannels | Remove one or more default channels from an org... |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.usergroups:write`
Required: yes
-c, --channel_ids <channel_ids>
Comma-separated string of channel IDs
Required: yes
-u, --usergroup_id <usergroup_id>
ID of the IDP Group
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_assign | Add an Enterprise user to a workspace. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-u, --user_id <user_id>
The ID of the user to add to the workspace.
Required: yes
-i, --is_ultra_restricted [is_ultra_restricted]
True if user should be added to the workspace as a single-channel guest.
Required: no
Permitted values: false, true
-v, --team_id <team_id>
The ID (`T1234`) of the workspace.
Required: yes
-c, --channel_ids [channel_ids]
Comma separated values of channel IDs to add user in the new workspace.
Required: no
-j, --is_restricted [is_restricted]
True if user should be added to the workspace as a guest.
Required: no
Permitted values: false, true
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_invite | Invite a user to a workspace. |
|
Action options:
-r, --real_name [real_name]
Full name of the user.
Required: no
-c, --channel_ids <channel_ids>
A comma-separated list of `channel_id`s for this user to join. At least one channel is required.
Required: yes
-t, --team_id <team_id>
The ID (`T1234`) of the workspace.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-i, --is_restricted [is_restricted]
Is this user a multi-channel guest user? (default: false)
Required: no
Permitted values: false, true
-j, --is_ultra_restricted [is_ultra_restricted]
Is this user a single channel guest user? (default: false)
Required: no
Permitted values: false, true
-s, --resend [resend]
Allow this invite to be resent in the future if a user has not signed up yet. (default: false)
Required: no
Permitted values: false, true
-e, --email <email>
The email address of the person to invite.
Required: yes
-d, --custom_message [custom_message]
An optional message to send to the user in the invite email.
Required: no
-g, --guest_expiration_ts [guest_expiration_ts]
Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.
Required: no
-f, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-k, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-v, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_list | List users on a workspace |
|
Action options:
-l, --limit [limit]
Limit for how many users to be retrieved per page
Required: no
-c, --cursor [cursor]
Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
Required: no
-t, --team_id <team_id>
The ID (`T1234`) of the workspace.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `admin.users:read`
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_remove | Remove a user from a workspace. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-u, --team_id <team_id>
The ID (`T1234`) of the workspace.
Required: yes
-v, --user_id <user_id>
The ID of the user to remove.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_session_invalidate | Invalidate a single session for a user by session_id |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-u, --team_id <team_id>
ID of the team that the session belongs to
Required: yes
-s, --session_id <session_id>
session_id
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_session_reset | Wipes all valid sessions on all devices for a given user |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-u, --user_id <user_id>
The ID of the user to wipe sessions for
Required: yes
-m, --mobile_only [mobile_only]
Only expire mobile sessions (default: false)
Required: no
Permitted values: false, true
-w, --web_only [web_only]
Only expire web sessions (default: false)
Required: no
Permitted values: false, true
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_setadmin | Set an existing guest, regular user, or owner to be an admin user. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-u, --team_id <team_id>
The ID (`T1234`) of the workspace.
Required: yes
-v, --user_id <user_id>
The ID of the user to designate as an admin.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_setexpiration | Set an expiration for a guest user |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-e, --expiration_ts <expiration_ts>
Timestamp when guest account should be disabled.
Required: yes
-u, --team_id <team_id>
The ID (`T1234`) of the workspace.
Required: yes
-v, --user_id <user_id>
The ID of the user to set an expiration for.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_setowner | Set an existing guest, regular user, or admin user to be a workspace owner. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-u, --user_id <user_id>
Id of the user to promote to owner.
Required: yes
-v, --team_id <team_id>
The ID (`T1234`) of the workspace.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
admin_users_setregular | Set an existing guest user, admin user, or owner to be a regular user. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin.users:write`
Required: yes
-u, --team_id <team_id>
The ID (`T1234`) of the workspace.
Required: yes
-v, --user_id <user_id>
The ID of the user to designate as a regular user.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
api_test | Checks API calling code. |
|
Action options:
-e, --error [error]
Error response to return
Required: no
-f, --foo [foo]
example property to return
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
apps_event_authorizations_list | Get a list of authorizations for the given event context... |
|
Action options:
-e, --event_context <event_context>
event_context
Required: yes
-c, --cursor [cursor]
cursor
Required: no
-l, --limit [limit]
limit
Required: no
-t, --token <token>
Authentication token. Requires scope: `authorizations:read`
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
apps_permissions_info | Returns list of permissions this app has on a team. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `none`
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
apps_permissions_request | Allows an app to request additional scopes |
|
Action options:
-s, --scopes <scopes>
A comma separated list of scopes to request for
Required: yes
-t, --trigger_id <trigger_id>
Token used to trigger the permissions API
Required: yes
-u, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
apps_permissions_resources_list | Returns list of resource grants this app has on a team. |
|
Action options:
-c, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-l, --limit [limit]
The maximum number of items to return.
Required: no
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
apps_permissions_scopes_list | Returns list of scopes this app has on a team. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
apps_permissions_users_list | Returns list of user grants and corresponding scopes this app has on a team... |
|
Action options:
-l, --limit [limit]
The maximum number of items to return.
Required: no
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-c, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
apps_permissions_users_request | Enables an app to trigger a permissions modal to grant an app access to a u... |
|
Action options:
-s, --scopes <scopes>
A comma separated list of user scopes to request for
Required: yes
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-u, --user <user>
The user this scope is being requested for
Required: yes
-v, --trigger_id <trigger_id>
Token used to trigger the request
Required: yes
-w, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
apps_uninstall | Uninstalls your app from a workspace. |
|
Action options:
-c, --client_secret [client_secret]
Issued when you created your application.
Required: no
-t, --token [token]
Authentication token. Requires scope: `none`
Required: no
-d, --client_id [client_id]
Issued when you created your application.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
auth_revoke | Revokes a token. |
|
Action options:
-t, --test [test]
Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.
Required: no
Permitted values: false, true
-u, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
auth_test | Checks authentication & identity. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
bots_info | Gets information about a bot user. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `users:read`
Required: yes
-b, --bot [bot]
Bot user to get info on
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
calls_add | Registers a new Call. |
|
Action options:
-d, --date_start [date_start]
Call start time in UTC UNIX timestamp format
Required: no
-e, --external_display_id [external_display_id]
An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
Required: no
-c, --created_by [created_by]
The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required.
Required: no
-u, --users [users]
The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
Required: no
-j, --join_url <join_url>
The URL required for a client to join the Call.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `calls:write`
Required: yes
-v, --title [title]
The name of the Call.
Required: no
-f, --external_unique_id <external_unique_id>
An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
Required: yes
-g, --desktop_app_join_url [desktop_app_join_url]
When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
Required: no
-h, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-k, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
calls_end | Ends a Call. |
|
Action options:
-i, --id <id>
`id` returned when registering the call using the [`calls.add`](/methods/calls.add) method.
Required: yes
-d, --duration [duration]
Call duration in seconds
Required: no
-t, --token <token>
Authentication token. Requires scope: `calls:write`
Required: yes
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
calls_info | Returns information about a Call. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `calls:read`
Required: yes
-i, --id <id>
`id` of the Call returned by the [`calls.add`](/methods/calls.add) method.
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
calls_participants_add | Registers new participants added to a Call. |
|
Action options:
-i, --id <id>
`id` returned by the [`calls.add`](/methods/calls.add) method.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `calls:write`
Required: yes
-u, --users <users>
The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
calls_participants_remove | Registers participants removed from a Call. |
|
Action options:
-i, --id <id>
`id` returned by the [`calls.add`](/methods/calls.add) method.
Required: yes
-u, --users <users>
The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
Required: yes
-t, --token <token>
Authentication token. Requires scope: `calls:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
calls_update | Updates information about a Call. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `calls:write`
Required: yes
-d, --desktop_app_join_url [desktop_app_join_url]
When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
Required: no
-u, --title [title]
The name of the Call.
Required: no
-j, --join_url [join_url]
The URL required for a client to join the Call.
Required: no
-i, --id <id>
`id` returned by the [`calls.add`](/methods/calls.add) method.
Required: yes
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_delete | Deletes a message. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `chat:write`
Required: no
-u, --ts [ts]
Timestamp of the message to be deleted.
Required: no
-a, --as_user [as_user]
Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.
Required: no
Permitted values: false, true
-c, --channel [channel]
Channel containing the message to be deleted.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_deletescheduledmessage | Deletes a pending scheduled message from the queue. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `chat:write`
Required: yes
-a, --as_user [as_user]
Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.
Required: no
Permitted values: false, true
-c, --channel <channel>
The channel the scheduled_message is posting to
Required: yes
-s, --scheduled_message_id <scheduled_message_id>
`scheduled_message_id` returned from call to chat.scheduleMessage
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_getpermalink | Retrieve a permalink URL for a specific extant message |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-c, --channel <channel>
The ID of the conversation or channel containing the message
Required: yes
-m, --message_ts <message_ts>
A message's `ts` value, uniquely identifying it within a channel
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_memessage | Share a me message into a channel. |
|
Action options:
-t, --text [text]
Text of the message to send.
Required: no
-c, --channel [channel]
Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
Required: no
-u, --token [token]
Authentication token. Requires scope: `chat:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_postephemeral | Sends an ephemeral message to a user in a channel. |
|
Action options:
-u, --username [username]
Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.
Required: no
-t, --token <token>
Authentication token. Requires scope: `chat:write`
Required: yes
-i, --icon_emoji [icon_emoji]
Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below.
Required: no
-v, --text [text]
How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.
Required: no
-l, --link_names [link_names]
Find and link channel names and usernames.
Required: no
Permitted values: false, true
-w, --thread_ts [thread_ts]
Provide another message's `ts` value to post this message in a thread. Avoid using a reply's `ts` value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.
Required: no
-j, --icon_url [icon_url]
URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.
Required: no
-b, --blocks [blocks]
A JSON-based array of structured blocks, presented as a URL-encoded string.
Required: no
-p, --parse [parse]
Change how messages are treated. Defaults to `none`. See [below](#formatting).
Required: no
-a, --as_user [as_user]
Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
Required: no
Permitted values: false, true
-x, --user <user>
`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.
Required: yes
-c, --channel <channel>
Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
Required: yes
-d, --attachments [attachments]
A JSON-based array of structured attachments, presented as a URL-encoded string.
Required: no
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_postmessage | Sends a message to a channel. |
|
Action options:
-r, --reply_broadcast [reply_broadcast]
Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.
Required: no
Permitted values: false, true
-u, --unfurl_links [unfurl_links]
Pass true to enable unfurling of primarily text-based content.
Required: no
Permitted values: false, true
-v, --unfurl_media [unfurl_media]
Pass false to disable unfurling of media content.
Required: no
Permitted values: false, true
-t, --text [text]
How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.
Required: no
-a, --as_user [as_user]
Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.
Required: no
-c, --channel <channel>
Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.
Required: yes
-i, --icon_url [icon_url]
URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.
Required: no
-b, --attachments [attachments]
A JSON-based array of structured attachments, presented as a URL-encoded string.
Required: no
-w, --username [username]
Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.
Required: no
-m, --mrkdwn [mrkdwn]
Disable Slack markup parsing by setting to `false`. Enabled by default.
Required: no
Permitted values: false, true
-x, --token <token>
Authentication token. Requires scope: `chat:write`
Required: yes
-j, --icon_emoji [icon_emoji]
Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below.
Required: no
-y, --thread_ts [thread_ts]
Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.
Required: no
-l, --link_names [link_names]
Find and link channel names and usernames.
Required: no
Permitted values: false, true
-d, --blocks [blocks]
A JSON-based array of structured blocks, presented as a URL-encoded string.
Required: no
-p, --parse [parse]
Change how messages are treated. Defaults to `none`. See [below](#formatting).
Required: no
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_scheduledmessages_list | Returns a list of scheduled messages. |
|
Action options:
-l, --latest [latest]
A UNIX timestamp of the latest value in the time range
Required: no
-m, --limit [limit]
Maximum number of original entries to return.
Required: no
-o, --oldest [oldest]
A UNIX timestamp of the oldest value in the time range
Required: no
-t, --token [token]
Authentication token. Requires scope: `none`
Required: no
-c, --channel [channel]
The channel of the scheduled messages
Required: no
-d, --cursor [cursor]
For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_schedulemessage | Schedules a message to be sent to a channel. |
|
Action options:
-p, --parse [parse]
Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting).
Required: no
-l, --link_names [link_names]
Find and link channel names and usernames.
Required: no
Permitted values: false, true
-t, --token [token]
Authentication token. Requires scope: `chat:write`
Required: no
-q, --post_at [post_at]
Unix EPOCH timestamp of time in future to send the message.
Required: no
-u, --text [text]
How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.
Required: no
-a, --as_user [as_user]
Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [chat.postMessage](chat.postMessage#authorship).
Required: no
Permitted values: false, true
-v, --thread_ts [thread_ts]
Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.
Required: no
-w, --unfurl_links [unfurl_links]
Pass true to enable unfurling of primarily text-based content.
Required: no
Permitted values: false, true
-b, --attachments [attachments]
A JSON-based array of structured attachments, presented as a URL-encoded string.
Required: no
-c, --blocks [blocks]
A JSON-based array of structured blocks, presented as a URL-encoded string.
Required: no
-d, --channel [channel]
Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.
Required: no
-r, --reply_broadcast [reply_broadcast]
Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.
Required: no
Permitted values: false, true
-x, --unfurl_media [unfurl_media]
Pass false to disable unfurling of media content.
Required: no
Permitted values: false, true
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-y, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_unfurl | Provide custom unfurl behavior for user-posted URLs |
|
Action options:
-u, --user_auth_url [user_auth_url]
Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
Required: no
-t, --ts <ts>
Timestamp of the message to add unfurl behavior to.
Required: yes
-c, --channel <channel>
Channel ID of the message
Required: yes
-v, --unfurls [unfurls]
URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.
Required: no
-w, --user_auth_message [user_auth_message]
Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior
Required: no
-x, --user_auth_required [user_auth_required]
Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain
Required: no
Permitted values: false, true
-y, --token <token>
Authentication token. Requires scope: `links:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
chat_update | Updates a message. |
|
Action options:
-b, --blocks [blocks]
A JSON-based array of [structured blocks](/block-kit/building), presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field.
Required: no
-l, --link_names [link_names]
Find and link channel names and usernames. Defaults to `none`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `none`.
Required: no
-a, --attachments [attachments]
A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`. If you don't include this field, the message's previous `attachments` will be retained. To remove previous `attachments`, include an empty array for this field.
Required: no
-t, --token <token>
Authentication token. Requires scope: `chat:write`
Required: yes
-u, --ts <ts>
Timestamp of the message to be updated.
Required: yes
-p, --parse [parse]
Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `client`.
Required: no
-c, --channel <channel>
Channel containing the message to be updated.
Required: yes
-v, --text [text]
New text for the message, using the [default formatting rules](/reference/surfaces/formatting). It's not required when presenting `blocks` or `attachments`.
Required: no
-d, --as_user [as_user]
Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users.
Required: no
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_archive | Archives a conversation. |
|
Action options:
-c, --channel [channel]
ID of conversation to archive
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_close | Closes a direct message or multi-person direct message. |
|
Action options:
-c, --channel [channel]
Conversation to close.
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_create | Initiates a public or private channel-based conversation |
|
Action options:
-n, --name [name]
Name of the public or private channel to create
Required: no
-i, --is_private [is_private]
Create a private channel instead of a public one
Required: no
Permitted values: false, true
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_history | Fetches a conversation's history of messages and events. |
|
Action options:
-i, --inclusive [inclusive]
Include messages with latest or oldest timestamp in results only when either timestamp is specified.
Required: no
Permitted values: false, true
-t, --token [token]
Authentication token. Requires scope: `conversations:history`
Required: no
-c, --channel [channel]
Conversation ID to fetch history for.
Required: no
-o, --oldest [oldest]
Start of time range of messages to include in results.
Required: no
-d, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-l, --latest [latest]
End of time range of messages to include in results.
Required: no
-m, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_info | Retrieve information about a conversation. |
|
Action options:
-i, --include_num_members [include_num_members]
Set to `true` to include the member count for the specified conversation. Defaults to `false`
Required: no
Permitted values: false, true
-t, --token [token]
Authentication token. Requires scope: `conversations:read`
Required: no
-j, --include_locale [include_locale]
Set this to `true` to receive the locale for this conversation. Defaults to `false`
Required: no
Permitted values: false, true
-c, --channel [channel]
Conversation ID to learn more about
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_invite | Invites users to a channel. |
|
Action options:
-c, --channel [channel]
The ID of the public or private channel to invite user(s) to.
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-u, --users [users]
A comma separated list of user IDs. Up to 1000 users may be listed.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_join | Joins an existing conversation. |
|
Action options:
-c, --channel [channel]
ID of conversation to join
Required: no
-t, --token [token]
Authentication token. Requires scope: `channels:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_kick | Removes a user from a conversation. |
|
Action options:
-c, --channel [channel]
ID of conversation to remove user from.
Required: no
-u, --user [user]
User ID to be removed.
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_leave | Leaves a conversation. |
|
Action options:
-c, --channel [channel]
Conversation to leave
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_list | Lists all channels in a Slack team. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `conversations:read`
Required: no
-l, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.
Required: no
-u, --types [types]
Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
Required: no
-e, --exclude_archived [exclude_archived]
Set to `true` to exclude archived channels from the list
Required: no
Permitted values: false, true
-c, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_mark | Sets the read cursor in a channel. |
|
Action options:
-t, --ts [ts]
Unique identifier of message you want marked as most recently seen in this conversation.
Required: no
-u, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-c, --channel [channel]
Channel or conversation to set the read cursor for.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_members | Retrieve members of a conversation. |
|
Action options:
-c, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:read`
Required: no
-l, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
Required: no
-d, --channel [channel]
ID of the conversation to retrieve members for
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_open | Opens or resumes a direct message or multi-person direct message. |
|
Action options:
-r, --return_im [return_im]
Boolean, indicates you want the full IM channel definition in the response.
Required: no
Permitted values: false, true
-c, --channel [channel]
Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.
Required: no
-u, --users [users]
Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`.
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_rename | Renames a conversation. |
|
Action options:
-n, --name [name]
New name for conversation.
Required: no
-c, --channel [channel]
ID of conversation to rename
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_replies | Retrieve a thread of messages posted to a conversation |
|
Action options:
-c, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-l, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
Required: no
-o, --oldest [oldest]
Start of time range of messages to include in results.
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:history`
Required: no
-m, --latest [latest]
End of time range of messages to include in results.
Required: no
-u, --ts [ts]
Unique identifier of a thread's parent message. `ts` must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by `ts` will return - it is just an ordinary, unthreaded message.
Required: no
-i, --inclusive [inclusive]
Include messages with latest or oldest timestamp in results only when either timestamp is specified.
Required: no
Permitted values: false, true
-d, --channel [channel]
Conversation ID to fetch thread from.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_setpurpose | Sets the purpose for a conversation. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-c, --channel [channel]
Conversation to set the purpose of
Required: no
-p, --purpose [purpose]
A new, specialer purpose
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_settopic | Sets the topic for a conversation. |
|
Action options:
-c, --channel [channel]
Conversation to set the topic of
Required: no
-t, --topic [topic]
The new topic string. Does not support formatting or linkification.
Required: no
-u, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
conversations_unarchive | Reverses conversation archival. |
|
Action options:
-c, --channel [channel]
ID of conversation to unarchive
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
dialog_open | Open a dialog with a user |
|
Action options:
-t, --trigger_id <trigger_id>
Exchange a trigger to post to the user.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-d, --dialog <dialog>
The dialog definition. This must be a JSON-encoded string.
Required: yes
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
dnd_enddnd | Ends the current user's Do Not Disturb session immediately. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `dnd:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
dnd_endsnooze | Ends the current user's snooze mode immediately. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `dnd:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
dnd_info | Retrieves a user's current Do Not Disturb status. |
|
Action options:
-u, --user [user]
User to fetch status for (defaults to current user)
Required: no
-t, --token [token]
Authentication token. Requires scope: `dnd:read`
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
dnd_setsnooze | Turns on Do Not Disturb mode for the current user, or changes its duration. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `dnd:write`
Required: yes
-n, --num_minutes <num_minutes>
Number of minutes, from now, to snooze until.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
dnd_teaminfo | Retrieves the Do Not Disturb status for up to 50 users on a team. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `dnd:read`
Required: no
-u, --users [users]
Comma-separated list of users to fetch Do Not Disturb status for
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
emoji_list | Lists custom emoji for a team. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `emoji:read`
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_comments_delete | Deletes an existing comment on a file. |
| |
files_delete | Deletes a file. |
|
Action options:
-f, --file [file]
ID of file to delete.
Required: no
-t, --token [token]
Authentication token. Requires scope: `files:write:user`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_info | Gets information about a file. |
|
Action options:
-l, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
Required: no
-c, --count [count]
count
Required: no
-f, --file [file]
Specify a file by providing its ID.
Required: no
-p, --page [page]
page
Required: no
-d, --cursor [cursor]
Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See [pagination](/docs/pagination) for more details.
Required: no
-t, --token [token]
Authentication token. Requires scope: `files:read`
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_list | List for a team, in a channel, or from a user with applied filters. |
|
Action options:
-c, --channel [channel]
Filter files appearing in a specific channel, indicated by its ID.
Required: no
-t, --ts_from [ts_from]
Filter files created after this timestamp (inclusive).
Required: no
-s, --show_files_hidden_by_limit [show_files_hidden_by_limit]
Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.
Required: no
Permitted values: false, true
-u, --token [token]
Authentication token. Requires scope: `files:read`
Required: no
-v, --types [types]
Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list.
Required: no
-p, --page [page]
page
Required: no
-w, --ts_to [ts_to]
Filter files created before this timestamp (inclusive).
Required: no
-x, --user [user]
Filter files created by a single user.
Required: no
-d, --count [count]
count
Required: no
-y, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_remote_add | Adds a file from a remote service |
|
Action options:
-p, --preview_image [preview_image]
Preview of the document via `multipart/form-data`.
Required: no
-e, --external_id [external_id]
Creator defined GUID for the file.
Required: no
-t, --title [title]
Title of the file being shared.
Required: no
-f, --external_url [external_url]
URL of the remote file.
Required: no
-u, --token [token]
Authentication token. Requires scope: `remote_files:write`
Required: no
-i, --indexable_file_contents [indexable_file_contents]
A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.
Required: no
-g, --filetype [filetype]
type of file
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-j, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_remote_info | Retrieve information about a remote file added to Slack |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `remote_files:read`
Required: no
-e, --external_id [external_id]
Creator defined GUID for the file.
Required: no
-f, --file [file]
Specify a file by providing its ID.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_remote_list | Retrieve information about a remote file added to Slack |
|
Action options:
-t, --ts_to [ts_to]
Filter files created before this timestamp (inclusive).
Required: no
-c, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-u, --token [token]
Authentication token. Requires scope: `remote_files:read`
Required: no
-d, --channel [channel]
Filter files appearing in a specific channel, indicated by its ID.
Required: no
-l, --limit [limit]
The maximum number of items to return.
Required: no
-v, --ts_from [ts_from]
Filter files created after this timestamp (inclusive).
Required: no
-w, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_remote_remove | Remove a remote file. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `remote_files:write`
Required: no
-f, --file [file]
Specify a file by providing its ID.
Required: no
-e, --external_id [external_id]
Creator defined GUID for the file.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-h, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_remote_share | Share a remote file into a channel. |
|
Action options:
-f, --file [file]
Specify a file registered with Slack by providing its ID. Either this field or `external_id` or both are required.
Required: no
-t, --token [token]
Authentication token. Requires scope: `remote_files:share`
Required: no
-c, --channels [channels]
Comma-separated list of channel IDs where the file will be shared.
Required: no
-e, --external_id [external_id]
The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or `file` or both are required.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_remote_update | Updates an existing remote file. |
|
Action options:
-f, --file [file]
Specify a file by providing its ID.
Required: no
-i, --indexable_file_contents [indexable_file_contents]
File containing contents that can be used to improve searchability for the remote file.
Required: no
-g, --filetype [filetype]
type of file
Required: no
-e, --external_url [external_url]
URL of the remote file.
Required: no
-p, --preview_image [preview_image]
Preview of the document via `multipart/form-data`.
Required: no
-h, --external_id [external_id]
Creator defined GUID for the file.
Required: no
-t, --title [title]
Title of the file being shared.
Required: no
-u, --token [token]
Authentication token. Requires scope: `remote_files:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-k, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_revokepublicurl | Revokes public/external sharing access for a file |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `files:write:user`
Required: no
-f, --file [file]
File to revoke
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_sharedpublicurl | Enables a file for public/external sharing. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `files:write:user`
Required: no
-f, --file [file]
File to share
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
files_upload | Uploads or creates a file. |
|
Action options:
-i, --initial_comment [initial_comment]
The message text introducing the file in specified `channels`.
Required: no
-c, --content [content]
File contents via a POST variable. If omitting this parameter, you must provide a `file`.
Required: no
-f, --file [file]
File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`.
Required: no
-t, --thread_ts [thread_ts]
Provide another message's `ts` value to upload this file as a reply. Never use a reply's `ts` value; use its parent instead.
Required: no
-u, --title [title]
Title of file.
Required: no
-g, --filetype [filetype]
A [file type](/types/file#file_types) identifier.
Required: no
-d, --channels [channels]
Comma-separated list of channel names or IDs where the file will be shared.
Required: no
-h, --filename [filename]
Filename of file.
Required: no
-v, --token [token]
Authentication token. Requires scope: `files:write:user`
Required: no
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-k, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
migration_exchange | For Enterprise Grid workspaces, map local user IDs to global user IDs |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `tokens.basic`
Required: yes
-u, --to_old [to_old]
Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`.
Required: no
Permitted values: false, true
-v, --team_id [team_id]
Specify team_id starts with `T` in case of Org Token
Required: no
-w, --users <users>
A comma-separated list of user ids, up to 400 per request
Required: yes
-x, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
oauth_access | Exchanges a temporary OAuth verifier code for an access token. |
|
Action options:
-r, --redirect_uri [redirect_uri]
This must match the originally submitted URI (if one was sent).
Required: no
-c, --client_secret [client_secret]
Issued when you created your application.
Required: no
-d, --code [code]
The `code` param returned via the OAuth callback.
Required: no
-s, --single_channel [single_channel]
Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps).
Required: no
Permitted values: false, true
-e, --client_id [client_id]
Issued when you created your application.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-t, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
oauth_token | Exchanges a temporary OAuth verifier code for a workspace token. |
|
Action options:
-c, --client_id [client_id]
Issued when you created your application.
Required: no
-s, --single_channel [single_channel]
Request the user to add your app only to a single channel.
Required: no
Permitted values: false, true
-d, --client_secret [client_secret]
Issued when you created your application.
Required: no
-e, --code [code]
The `code` param returned via the OAuth callback.
Required: no
-r, --redirect_uri [redirect_uri]
This must match the originally submitted URI (if one was sent).
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-t, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
oauth_v2_access | Exchanges a temporary OAuth verifier code for an access token. |
|
Action options:
-c, --client_id [client_id]
Issued when you created your application.
Required: no
-d, --client_secret [client_secret]
Issued when you created your application.
Required: no
-e, --code <code>
The `code` param returned via the OAuth callback.
Required: yes
-r, --redirect_uri [redirect_uri]
This must match the originally submitted URI (if one was sent).
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
pins_add | Pins an item to a channel. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `pins:write`
Required: yes
-u, --timestamp [timestamp]
Timestamp of the message to pin.
Required: no
-c, --channel <channel>
Channel to pin the item in.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
pins_list | Lists items pinned to a channel. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `pins:read`
Required: yes
-c, --channel <channel>
Channel to get pinned items for.
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
pins_remove | Un-pins an item from a channel. |
|
Action options:
-c, --channel <channel>
Channel where the item is pinned to.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `pins:write`
Required: yes
-u, --timestamp [timestamp]
Timestamp of the message to un-pin.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reactions_add | Adds a reaction to an item. |
|
Action options:
-c, --channel <channel>
Channel where the message to add reaction to was posted.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `reactions:write`
Required: yes
-n, --name <name>
Reaction (emoji) name.
Required: yes
-u, --timestamp <timestamp>
Timestamp of the message to add reaction to.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reactions_get | Gets reactions for an item. |
|
Action options:
-f, --full [full]
If true always return the complete reaction list.
Required: no
Permitted values: false, true
-t, --token <token>
Authentication token. Requires scope: `reactions:read`
Required: yes
-g, --file [file]
File to get reactions for.
Required: no
-c, --channel [channel]
Channel where the message to get reactions for was posted.
Required: no
-h, --file_comment [file_comment]
File comment to get reactions for.
Required: no
-u, --timestamp [timestamp]
Timestamp of the message to get reactions for.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reactions_list | Lists reactions made by a user. |
|
Action options:
-c, --count [count]
count
Required: no
-d, --cursor [cursor]
Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details.
Required: no
-u, --user [user]
Show reactions made by this user. Defaults to the authed user.
Required: no
-t, --token <token>
Authentication token. Requires scope: `reactions:read`
Required: yes
-f, --full [full]
If true always return the complete reaction list.
Required: no
Permitted values: false, true
-p, --page [page]
page
Required: no
-l, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reactions_remove | Removes a reaction from an item. |
|
Action options:
-n, --name <name>
Reaction (emoji) name.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `reactions:write`
Required: yes
-f, --file [file]
File to remove reaction from.
Required: no
-g, --file_comment [file_comment]
File comment to remove reaction from.
Required: no
-u, --timestamp [timestamp]
Timestamp of the message to remove reaction from.
Required: no
-c, --channel [channel]
Channel where the message to remove reaction from was posted.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-h, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reminders_add | Creates a reminder. |
|
Action options:
-t, --text <text>
The content of the reminder
Required: yes
-u, --time <time>
When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday")
Required: yes
-v, --token <token>
Authentication token. Requires scope: `reminders:write`
Required: yes
-w, --user [user]
The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reminders_complete | Marks a reminder as complete. |
|
Action options:
-r, --reminder [reminder]
The ID of the reminder to be marked as complete
Required: no
-t, --token [token]
Authentication token. Requires scope: `reminders:write`
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reminders_delete | Deletes a reminder. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `reminders:write`
Required: no
-r, --reminder [reminder]
The ID of the reminder
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reminders_info | Gets information about a reminder. |
|
Action options:
-r, --reminder [reminder]
The ID of the reminder
Required: no
-t, --token [token]
Authentication token. Requires scope: `reminders:read`
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-s, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
reminders_list | Lists all reminders created by or for a given user. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `reminders:read`
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
rtm_connect | Starts a Real Time Messaging session. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `rtm:stream`
Required: yes
-p, --presence_sub [presence_sub]
Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).
Required: no
Permitted values: false, true
-b, --batch_presence_aware [batch_presence_aware]
Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).
Required: no
Permitted values: false, true
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
search_messages | Searches for messages matching a query. |
|
Action options:
-q, --query <query>
Search query.
Required: yes
-p, --page [page]
page
Required: no
-h, --highlight [highlight]
Pass a value of `true` to enable query highlight markers (see below).
Required: no
Permitted values: false, true
-c, --count [count]
Pass the number of results you want per "page". Maximum of `100`.
Required: no
-t, --token <token>
Authentication token. Requires scope: `search:read`
Required: yes
-s, --sort [sort]
Return matches sorted by either `score` or `timestamp`.
Required: no
-u, --sort_dir [sort_dir]
Change sort direction to ascending (`asc`) or descending (`desc`).
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-w, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
stars_add | Adds a star to an item. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `stars:write`
Required: yes
-c, --channel [channel]
Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`).
Required: no
-f, --file [file]
File to add star to.
Required: no
-u, --timestamp [timestamp]
Timestamp of the message to add star to.
Required: no
-g, --file_comment [file_comment]
File comment to add star to.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-h, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
stars_list | Lists stars for a user. |
|
Action options:
-c, --cursor [cursor]
Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details.
Required: no
-p, --page [page]
page
Required: no
-t, --token [token]
Authentication token. Requires scope: `stars:read`
Required: no
-l, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
Required: no
-d, --count [count]
count
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
stars_remove | Removes a star from an item. |
|
Action options:
-c, --channel [channel]
Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`).
Required: no
-t, --token <token>
Authentication token. Requires scope: `stars:write`
Required: yes
-f, --file_comment [file_comment]
File comment to remove star from.
Required: no
-g, --file [file]
File to remove star from.
Required: no
-u, --timestamp [timestamp]
Timestamp of the message to remove star from.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-h, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
team_accesslogs | Gets the access logs for the current team. |
|
Action options:
-b, --before [before]
End of time range of logs to include in results (inclusive).
Required: no
-p, --page [page]
page
Required: no
-t, --token <token>
Authentication token. Requires scope: `admin`
Required: yes
-c, --count [count]
count
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
team_billableinfo | Gets billable users information for the current team. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin`
Required: yes
-u, --user [user]
A user to retrieve the billable information for. Defaults to all users.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
team_info | Gets information about the current team. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `team:read`
Required: yes
-u, --team [team]
Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
team_integrationlogs | Gets the integration logs for the current team. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `admin`
Required: yes
-c, --change_type [change_type]
Filter logs with this change type. Defaults to all logs.
Required: no
-s, --service_id [service_id]
Filter logs to this service. Defaults to all logs.
Required: no
-u, --user [user]
Filter logs generated by this user’s actions. Defaults to all logs.
Required: no
-a, --app_id [app_id]
Filter logs to this Slack app. Defaults to all logs.
Required: no
-d, --count [count]
count
Required: no
-p, --page [page]
page
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
team_profile_get | Retrieve a team's profile. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `users.profile:read`
Required: yes
-v, --visibility [visibility]
Filter by visibility.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
usergroups_create | Create a User Group |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `usergroups:write`
Required: yes
-i, --include_count [include_count]
Include the number of users in each User Group.
Required: no
Permitted values: false, true
-h, --handle [handle]
A mention handle. Must be unique among channels, users and User Groups.
Required: no
-d, --description [description]
A short description of the User Group.
Required: no
-n, --name <name>
A name for the User Group. Must be unique among User Groups.
Required: yes
-c, --channels [channels]
A comma separated string of encoded channel IDs for which the User Group uses as a default.
Required: no
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
usergroups_disable | Disable an existing User Group |
|
Action options:
-u, --usergroup <usergroup>
The encoded ID of the User Group to disable.
Required: yes
-i, --include_count [include_count]
Include the number of users in the User Group.
Required: no
Permitted values: false, true
-t, --token <token>
Authentication token. Requires scope: `usergroups:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
usergroups_enable | Enable a User Group |
|
Action options:
-i, --include_count [include_count]
Include the number of users in the User Group.
Required: no
Permitted values: false, true
-t, --token <token>
Authentication token. Requires scope: `usergroups:write`
Required: yes
-u, --usergroup <usergroup>
The encoded ID of the User Group to enable.
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
usergroups_list | List all User Groups for a team |
|
Action options:
-i, --include_count [include_count]
Include the number of users in each User Group.
Required: no
Permitted values: false, true
-j, --include_disabled [include_disabled]
Include disabled User Groups.
Required: no
Permitted values: false, true
-k, --include_users [include_users]
Include the list of users for each User Group.
Required: no
Permitted values: false, true
-t, --token <token>
Authentication token. Requires scope: `usergroups:read`
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
usergroups_update | Update an existing User Group |
|
Action options:
-c, --channels [channels]
A comma separated string of encoded channel IDs for which the User Group uses as a default.
Required: no
-h, --handle [handle]
A mention handle. Must be unique among channels, users and User Groups.
Required: no
-d, --description [description]
A short description of the User Group.
Required: no
-i, --include_count [include_count]
Include the number of users in the User Group.
Required: no
Permitted values: false, true
-t, --token <token>
Authentication token. Requires scope: `usergroups:write`
Required: yes
-u, --usergroup <usergroup>
The encoded ID of the User Group to update.
Required: yes
-n, --name [name]
A name for the User Group. Must be unique among User Groups.
Required: no
-e, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-g, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
usergroups_users_list | List all users in a User Group |
|
Action options:
-u, --usergroup <usergroup>
The encoded ID of the User Group to update.
Required: yes
-t, --token <token>
Authentication token. Requires scope: `usergroups:read`
Required: yes
-i, --include_disabled [include_disabled]
Allow results that involve disabled User Groups.
Required: no
Permitted values: false, true
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
usergroups_users_update | Update the list of users for a User Group |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `usergroups:write`
Required: yes
-u, --users <users>
A comma separated string of encoded user IDs that represent the entire list of users for the User Group.
Required: yes
-v, --usergroup <usergroup>
The encoded ID of the User Group to update.
Required: yes
-i, --include_count [include_count]
Include the number of users in the User Group.
Required: no
Permitted values: false, true
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_conversations | List conversations the calling user may access. |
|
Action options:
-u, --user [user]
Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
Required: no
-c, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-t, --token [token]
Authentication token. Requires scope: `conversations:read`
Required: no
-e, --exclude_archived [exclude_archived]
Set to `true` to exclude archived channels from the list
Required: no
Permitted values: false, true
-l, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.
Required: no
-v, --types [types]
Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
Required: no
-w, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_deletephoto | Delete the user profile photo |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `users.profile:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_getpresence | Gets user presence information. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `users:read`
Required: yes
-u, --user [user]
User to get presence info on. Defaults to the authed user.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_identity | Get a user's identity. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `identity.basic`
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_info | Gets information about a user. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `users:read`
Required: yes
-i, --include_locale [include_locale]
Set this to `true` to receive the locale for this user. Defaults to `false`
Required: no
Permitted values: false, true
-u, --user [user]
User to get info on
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_list | Lists all users in a Slack team. |
|
Action options:
-t, --token [token]
Authentication token. Requires scope: `users:read`
Required: no
-i, --include_locale [include_locale]
Set this to `true` to receive the locale for users. Defaults to `false`
Required: no
Permitted values: false, true
-c, --cursor [cursor]
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
Required: no
-l, --limit [limit]
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_lookupbyemail | Find a user with an email address. |
|
Action options:
-e, --email <email>
An email address belonging to a user in the workspace
Required: yes
-t, --token <token>
Authentication token. Requires scope: `users:read.email`
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_profile_get | Retrieves a user's profile information. |
|
Action options:
-i, --include_labels [include_labels]
Include labels for each ID in custom profile fields
Required: no
Permitted values: false, true
-t, --token <token>
Authentication token. Requires scope: `users.profile:read`
Required: yes
-u, --user [user]
User to retrieve profile info for
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_profile_set | Set the profile information for a user. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `users.profile:write`
Required: yes
-v, --value [value]
Value to set a single key to. Usable only if `profile` is not passed.
Required: no
-p, --profile [profile]
Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.
Required: no
-n, --name [name]
Name of a single key to set. Usable only if `profile` is not passed.
Required: no
-u, --user [user]
ID of user to change. This argument may only be specified by team admins on paid teams.
Required: no
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_setactive | Marked a user as active. Deprecated and non-functional. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `users:write`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_setphoto | Set the user profile photo |
|
Action options:
-c, --crop_w [crop_w]
Width/height of crop box (always square)
Required: no
-t, --token <token>
Authentication token. Requires scope: `users.profile:write`
Required: yes
-d, --crop_y [crop_y]
Y coordinate of top-left corner of crop box
Required: no
-e, --crop_x [crop_x]
X coordinate of top-left corner of crop box
Required: no
-i, --image [image]
File contents via `multipart/form-data`.
Required: no
-f, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-h, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
users_setpresence | Manually sets user presence. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `users:write`
Required: yes
-p, --presence <presence>
Either `auto` or `away`
Required: yes
-d, --data_url [data_url]
The URL of a document containing input data for the action.
The data is sent in the HTTP request body exactly as supplied.
Required: no
-f, --encoding <encoding>
The MIME type of the body data.
Required: yes
Permitted values: application/json, application/x-www-form-urlencoded
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
views_open | Open a view for a user. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-v, --view <view>
A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.
Required: yes
-u, --trigger_id <trigger_id>
Exchange a trigger to post to the user.
Required: yes
-w, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
views_publish | Publish a static view for a User. |
|
Action options:
-h, --hash [hash]
A string that represents view state to protect against possible race conditions.
Required: no
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-v, --view <view>
A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.
Required: yes
-u, --user_id <user_id>
`id` of the user you want publish a view to.
Required: yes
-w, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
views_push | Push a view onto the stack of a root view. |
|
Action options:
-v, --view <view>
A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.
Required: yes
-t, --trigger_id <trigger_id>
Exchange a trigger to post to the user.
Required: yes
-u, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-w, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
views_update | Update an existing view. |
|
Action options:
-e, --external_id [external_id]
A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required.
Required: no
-v, --view [view]
A [view object](/reference/surfaces/views). This must be a JSON-encoded string.
Required: no
-h, --hash [hash]
A string that represents view state to protect against possible race conditions.
Required: no
-t, --token <token>
Authentication token. Requires scope: `none`
Required: yes
-w, --view_id [view_id]
A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
workflows_stepcompleted | Indicate that an app's step in a workflow completed execution. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `workflow.steps:execute`
Required: yes
-w, --workflow_step_execute_id <workflow_step_execute_id>
Context identifier that maps to the correct workflow step execution.
Required: yes
-o, --outputs [outputs]
Key-value object of outputs from your step. Keys of this object reflect the configured `key` properties of your [`outputs`](/reference/workflows/workflow_step#output) array from your `workflow_step` object.
Required: no
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
workflows_stepfailed | Indicate that an app's step in a workflow failed to execute. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `workflow.steps:execute`
Required: yes
-w, --workflow_step_execute_id <workflow_step_execute_id>
Context identifier that maps to the correct workflow step execution.
Required: yes
-e, --error <error>
A JSON-based object with a `message` property that should contain a human readable error message.
Required: yes
-u, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|
workflows_updatestep | Update the configuration for a workflow extension step. |
|
Action options:
-t, --token <token>
Authentication token. Requires scope: `workflow.steps:execute`
Required: yes
-o, --outputs [outputs]
An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.
Required: no
-w, --workflow_step_edit_id <workflow_step_edit_id>
A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`.
Required: yes
-s, --step_image_url [step_image_url]
An optional field that can be used to override app image that is shown in the Workflow Builder.
Required: no
-i, --inputs [inputs]
A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. **Please note**: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. [Read more about variables in workflow steps here](/workflows/steps#variables).
Required: no
-u, --step_name [step_name]
An optional field that can be used to override the step name that is shown in the Workflow Builder.
Required: no
-v, --url_only [url_only]
Return only the action URL, not the action results
Required: no
-r, --response_format [response_format]
Sets the response media type through an Accept header.
Required: no
Permitted values: application/json
-q, --quality_values [quality_values]
Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5.
--response_format takes precedence.
Required: no
|