NAME
Net::Async::Slack::Commands - supported API methods for Net::Async::Slack
DESCRIPTION
These are available on the top-level Net::Async::Slack instance, and are autogenerated from the API specification.
admin_apps_approve
Approve an app for installation on a workspace.
Takes the following named parameters:
app_id- The id of the app to approve. (string, optional)request_id- The id of the request to approve. (string, optional)team_id- (string, optional)
Resolves to a structure representing the response.
admin_apps_approved_list
List approved apps for an org or workspace.
Takes the following named parameters:
limit- The maximum number of items to return. Must be between 1 - 1000 both inclusive. (integer, optional)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page (string, optional)team_id- (string, optional)enterprise_id- (string, optional)
Resolves to a structure representing the response.
admin_apps_requests_list
List app requests for a team/workspace.
Takes the following named parameters:
limit- The maximum number of items to return. Must be between 1 - 1000 both inclusive. (integer, optional)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page (string, optional)team_id- (string, optional)
Resolves to a structure representing the response.
admin_apps_restrict
Restrict an app for installation on a workspace.
Takes the following named parameters:
app_id- The id of the app to restrict. (string, optional)request_id- The id of the request to restrict. (string, optional)team_id- (string, optional)
Resolves to a structure representing the response.
admin_apps_restricted_list
List restricted apps for an org or workspace.
Takes the following named parameters:
limit- The maximum number of items to return. Must be between 1 - 1000 both inclusive. (integer, optional)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page (string, optional)team_id- (string, optional)enterprise_id- (string, optional)
Resolves to a structure representing the response.
admin_conversations_archive
Archive a public or private channel.
Takes the following named parameters:
channel_id- The channel to archive. (string, required)
Resolves to a structure representing the response.
admin_conversations_convert_to_private
Convert a public channel to a private channel.
Takes the following named parameters:
channel_id- The channel to convert to private. (string, required)
Resolves to a structure representing the response.
admin_conversations_create
Create a public or private channel-based conversation.
Takes the following named parameters:
name- Name of the public or private channel to create. (string, required)description- Description of the public or private channel to create. (string, optional)is_private- When `true`, creates a private channel instead of a public channel (boolean, required)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 (boolean, optional)team_id- The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`. (string, optional)
Resolves to a structure representing the response.
admin_conversations_delete
Delete a public or private channel.
Takes the following named parameters:
channel_id- The channel to delete. (string, required)
Resolves to a structure representing the response.
admin_conversations_disconnect_shared
Disconnect a connected channel from one or more workspaces.
Takes the following named parameters:
channel_id- The channel to be disconnected from some workspaces. (string, required)leaving_team_ids- The team to be removed from the channel. Currently only a single team id can be specified. (string, optional)
Resolves to a structure representing the response.
admin_conversations_ekm_list_original_connected_channel_info
List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.
Takes the following named parameters:
channel_ids- A comma-separated list of channels to filter to. (string, optional)team_ids- A comma-separated list of the workspaces to which the channels you would like returned belong. (string, optional)limit- The maximum number of items to return. Must be between 1 - 1000 both inclusive. (integer, optional)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. (string, optional)
Resolves to a structure representing the response.
admin_conversations_get_conversation_prefs
Get conversation preferences for a public or private channel.
Takes the following named parameters:
channel_id- The channel to get preferences for. (string, required)
Resolves to a structure representing the response.
admin_conversations_get_teams
Get all the workspaces a given public or private channel is connected to within this Enterprise org.
Takes the following named parameters:
channel_id- The channel to determine connected workspaces within the organization for. (string, required)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page (string, optional)limit- The maximum number of items to return. Must be between 1 - 1000 both inclusive. (integer, optional)
Resolves to a structure representing the response.
admin_conversations_invite
Invite a user to a public or private channel.
Takes the following named parameters:
user_ids- The users to invite. (string, required)channel_id- The channel that the users will be invited to. (string, required)
Resolves to a structure representing the response.
admin_conversations_rename
Rename a public or private channel.
Takes the following named parameters:
channel_id- The channel to rename. (string, required)name- (string, required)
Resolves to a structure representing the response.
admin_conversations_restrict_access_add_group
Add an allowlist of IDP groups for accessing a channel
Takes the following named parameters:
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. (string, optional)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. (string, required)channel_id- The channel to link this group to. (string, required)
Resolves to a structure representing the response.
admin_conversations_restrict_access_list_groups
List all IDP Groups linked to a channel
Takes the following named parameters:
channel_id- (string, required)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. (string, optional)
Resolves to a structure representing the response.
admin_conversations_restrict_access_remove_group
Remove a linked IDP group linked from a private channel
Takes the following named parameters:
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. (string, required)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. (string, required)channel_id- The channel to remove the linked group from. (string, required)
Resolves to a structure representing the response.
admin_conversations_search
Search for public or private channels in an Enterprise organization.
Takes the following named parameters:
team_ids- Comma separated string of team IDs, signifying the workspaces to search through. (string, optional)query- Name of the the channel to query by. (string, optional)limit- Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. (integer, optional)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. (string, optional)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). (string, optional)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 (string, optional)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) (string, optional)
Resolves to a structure representing the response.
admin_conversations_set_conversation_prefs
Set the posting permissions for a public or private channel.
Takes the following named parameters:
channel_id- The channel to set the prefs for (string, required)prefs- The prefs for this channel in a stringified JSON format. (string, required)
Resolves to a structure representing the response.
admin_conversations_set_teams
Set the workspaces in an Enterprise grid org that connect to a public or private channel.
Takes the following named parameters:
channel_id- The encoded `channel_id` to add or remove to workspaces. (string, required)team_id- The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel. (string, optional)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. (string, optional)org_channel- True if channel has to be converted to an org channel (boolean, optional)
Resolves to a structure representing the response.
admin_conversations_unarchive
Unarchive a public or private channel.
Takes the following named parameters:
channel_id- The channel to unarchive. (string, required)
Resolves to a structure representing the response.
admin_emoji_add
Add an emoji.
Takes the following named parameters:
name- The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included. (string, required)url- The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best. (string, required)
Resolves to a structure representing the response.
admin_emoji_add_alias
Add an emoji alias.
Takes the following named parameters:
name- The name of the emoji to be aliased. Colons (`:myemoji:`) around the value are not required, although they may be included. (string, required)alias_for- The alias of the emoji. (string, required)
Resolves to a structure representing the response.
admin_emoji_list
List emoji for an Enterprise Grid organization.
Takes the following named parameters:
cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page (string, optional)limit- The maximum number of items to return. Must be between 1 - 1000 both inclusive. (integer, optional)
Resolves to a structure representing the response.
admin_emoji_remove
Remove an emoji across an Enterprise Grid organization
Takes the following named parameters:
name- The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included. (string, required)
Resolves to a structure representing the response.
admin_emoji_rename
Rename an emoji.
Takes the following named parameters:
name- The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included. (string, required)new_name- The new name of the emoji. (string, required)
Resolves to a structure representing the response.
admin_invite_requests_approve
Approve a workspace invite request.
Takes the following named parameters:
team_id- ID for the workspace where the invite request was made. (string, optional)invite_request_id- ID of the request to invite. (string, required)
Resolves to a structure representing the response.
admin_invite_requests_approved_list
List all approved workspace invite requests.
Takes the following named parameters:
team_id- ID for the workspace where the invite requests were made. (string, optional)cursor- Value of the `next_cursor` field sent as part of the previous API response (string, optional)limit- The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive (integer, optional)
Resolves to a structure representing the response.
admin_invite_requests_denied_list
List all denied workspace invite requests.
Takes the following named parameters:
team_id- ID for the workspace where the invite requests were made. (string, optional)cursor- Value of the `next_cursor` field sent as part of the previous API response (string, optional)limit- The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive (integer, optional)
Resolves to a structure representing the response.
admin_invite_requests_deny
Deny a workspace invite request.
Takes the following named parameters:
team_id- ID for the workspace where the invite request was made. (string, optional)invite_request_id- ID of the request to invite. (string, required)
Resolves to a structure representing the response.
admin_invite_requests_list
List all pending workspace invite requests.
Takes the following named parameters:
team_id- ID for the workspace where the invite requests were made. (string, optional)cursor- Value of the `next_cursor` field sent as part of the previous API response (string, optional)limit- The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive (integer, optional)
Resolves to a structure representing the response.
admin_teams_admins_list
List all of the admins on a given workspace.
Takes the following named parameters:
limit- The maximum number of items to return. (integer, optional)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. (string, optional)team_id- (string, required)
Resolves to a structure representing the response.
admin_teams_create
Create an Enterprise team.
Takes the following named parameters:
team_domain- Team domain (for example, slacksoftballteam). (string, required)team_name- Team name (for example, Slack Softball Team). (string, required)team_description- Description for the team. (string, optional)team_discoverability- Who can join the team. A team's discoverability can be `open`, `closed`, `invite_only`, or `unlisted`. (string, optional)
Resolves to a structure representing the response.
admin_teams_list
List all teams on an Enterprise organization
Takes the following named parameters:
limit- The maximum number of items to return. Must be between 1 - 100 both inclusive. (integer, optional)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. (string, optional)
Resolves to a structure representing the response.
admin_teams_owners_list
List all of the owners on a given workspace.
Takes the following named parameters:
team_id- (string, required)limit- The maximum number of items to return. Must be between 1 - 1000 both inclusive. (integer, optional)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. (string, optional)
Resolves to a structure representing the response.
admin_teams_settings_info
Fetch information about settings in a workspace
Takes the following named parameters:
team_id- (string, required)
Resolves to a structure representing the response.
admin_teams_settings_set_default_channels
Set the default channels of a workspace.
Takes the following named parameters:
team_id- ID for the workspace to set the default channel for. (string, required)channel_ids- An array of channel IDs. (string, required)
Resolves to a structure representing the response.
admin_teams_settings_set_description
Set the description of a given workspace.
Takes the following named parameters:
team_id- ID for the workspace to set the description for. (string, required)description- The new description for the workspace. (string, required)
Resolves to a structure representing the response.
admin_teams_settings_set_discoverability
An API method that allows admins to set the discoverability of a given workspace
Takes the following named parameters:
team_id- The ID of the workspace to set discoverability on. (string, required)discoverability- This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`. (string, required)
Resolves to a structure representing the response.
admin_teams_settings_set_icon
Sets the icon of a workspace.
Takes the following named parameters:
image_url- Image URL for the icon (string, required)team_id- ID for the workspace to set the icon for. (string, required)
Resolves to a structure representing the response.
admin_teams_settings_set_name
Set the name of a given workspace.
Takes the following named parameters:
team_id- ID for the workspace to set the name for. (string, required)name- The new name of the workspace. (string, required)
Resolves to a structure representing the response.
admin_usergroups_add_channels
Add one or more default channels to an IDP group.
Takes the following named parameters:
usergroup_id- ID of the IDP group to add default channels for. (string, required)team_id- The workspace to add default channels in. (string, optional)channel_ids- Comma separated string of channel IDs. (string, required)
Resolves to a structure representing the response.
admin_usergroups_add_teams
Associate one or more default workspaces with an organization-wide IDP group.
Takes the following named parameters:
usergroup_id- An encoded usergroup (IDP Group) ID. (string, required)team_ids- A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token. (string, required)auto_provision- When `true`, this method automatically creates new workspace accounts for the IDP group members. (boolean, optional)
Resolves to a structure representing the response.
admin_usergroups_list_channels
List the channels linked to an org-level IDP group (user group).
Takes the following named parameters:
usergroup_id- ID of the IDP group to list default channels for. (string, required)team_id- ID of the the workspace. (string, optional)include_num_members- Flag to include or exclude the count of members per channel. (boolean, optional)
Resolves to a structure representing the response.
admin_usergroups_remove_channels
Remove one or more default channels from an org-level IDP group (user group).
Takes the following named parameters:
usergroup_id- ID of the IDP Group (string, required)channel_ids- Comma-separated string of channel IDs (string, required)
Resolves to a structure representing the response.
admin_users_assign
Add an Enterprise user to a workspace.
Takes the following named parameters:
team_id- The ID (`T1234`) of the workspace. (string, required)user_id- The ID of the user to add to the workspace. (string, required)is_restricted- True if user should be added to the workspace as a guest. (boolean, optional)is_ultra_restricted- True if user should be added to the workspace as a single-channel guest. (boolean, optional)channel_ids- Comma separated values of channel IDs to add user in the new workspace. (string, optional)
Resolves to a structure representing the response.
admin_users_invite
Invite a user to a workspace.
Takes the following named parameters:
team_id- The ID (`T1234`) of the workspace. (string, required)email- The email address of the person to invite. (string, required)channel_ids- A comma-separated list of `channel_id`s for this user to join. At least one channel is required. (string, required)custom_message- An optional message to send to the user in the invite email. (string, optional)real_name- Full name of the user. (string, optional)resend- Allow this invite to be resent in the future if a user has not signed up yet. (default: false) (boolean, optional)is_restricted- Is this user a multi-channel guest user? (default: false) (boolean, optional)is_ultra_restricted- Is this user a single channel guest user? (default: false) (boolean, optional)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. (string, optional)
Resolves to a structure representing the response.
admin_users_list
List users on a workspace
Takes the following named parameters:
team_id- The ID (`T1234`) of the workspace. (string, required)cursor- Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. (string, optional)limit- Limit for how many users to be retrieved per page (integer, optional)
Resolves to a structure representing the response.
admin_users_remove
Remove a user from a workspace.
Takes the following named parameters:
team_id- The ID (`T1234`) of the workspace. (string, required)user_id- The ID of the user to remove. (string, required)
Resolves to a structure representing the response.
admin_users_session_invalidate
Invalidate a single session for a user by session_id
Takes the following named parameters:
team_id- ID of the team that the session belongs to (string, required)session_id- (integer, required)
Resolves to a structure representing the response.
admin_users_session_reset
Wipes all valid sessions on all devices for a given user
Takes the following named parameters:
user_id- The ID of the user to wipe sessions for (string, required)mobile_only- Only expire mobile sessions (default: false) (boolean, optional)web_only- Only expire web sessions (default: false) (boolean, optional)
Resolves to a structure representing the response.
admin_users_set_admin
Set an existing guest, regular user, or owner to be an admin user.
Takes the following named parameters:
team_id- The ID (`T1234`) of the workspace. (string, required)user_id- The ID of the user to designate as an admin. (string, required)
Resolves to a structure representing the response.
admin_users_set_expiration
Set an expiration for a guest user
Takes the following named parameters:
team_id- The ID (`T1234`) of the workspace. (string, required)user_id- The ID of the user to set an expiration for. (string, required)expiration_ts- Timestamp when guest account should be disabled. (integer, required)
Resolves to a structure representing the response.
admin_users_set_owner
Set an existing guest, regular user, or admin user to be a workspace owner.
Takes the following named parameters:
team_id- The ID (`T1234`) of the workspace. (string, required)user_id- Id of the user to promote to owner. (string, required)
Resolves to a structure representing the response.
admin_users_set_regular
Set an existing guest user, admin user, or owner to be a regular user.
Takes the following named parameters:
team_id- The ID (`T1234`) of the workspace. (string, required)user_id- The ID of the user to designate as a regular user. (string, required)
Resolves to a structure representing the response.
api_test
Checks API calling code.
Takes the following named parameters:
error- Error response to return (string, optional)foo- example property to return (string, optional)
Resolves to a structure representing the response.
apps_event_authorizations_list
Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.
Takes the following named parameters:
event_context- (string, required)cursor- (string, optional)limit- (integer, optional)
Resolves to a structure representing the response.
apps_permissions_info
Returns list of permissions this app has on a team.
Resolves to a structure representing the response.
apps_permissions_request
Allows an app to request additional scopes
Takes the following named parameters:
scopes- A comma separated list of scopes to request for (string, required)trigger_id- Token used to trigger the permissions API (string, required)
Resolves to a structure representing the response.
apps_permissions_resources_list
Returns list of resource grants this app has on a team.
Takes the following named parameters:
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. (string, optional)limit- The maximum number of items to return. (integer, optional)
Resolves to a structure representing the response.
apps_permissions_scopes_list
Returns list of scopes this app has on a team.
Resolves to a structure representing the response.
apps_permissions_users_list
Returns list of user grants and corresponding scopes this app has on a team.
Takes the following named parameters:
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. (string, optional)limit- The maximum number of items to return. (integer, optional)
Resolves to a structure representing the response.
apps_permissions_users_request
Enables an app to trigger a permissions modal to grant an app access to a user access scope.
Takes the following named parameters:
scopes- A comma separated list of user scopes to request for (string, required)trigger_id- Token used to trigger the request (string, required)user- The user this scope is being requested for (string, required)
Resolves to a structure representing the response.
apps_uninstall
Uninstalls your app from a workspace.
Takes the following named parameters:
client_id- Issued when you created your application. (string, optional)client_secret- Issued when you created your application. (string, optional)
Resolves to a structure representing the response.
auth_revoke
Revokes a token.
Takes the following named parameters:
test- Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked. (boolean, optional)
Resolves to a structure representing the response.
auth_test
Checks authentication & identity.
Resolves to a structure representing the response.
bots_info
Gets information about a bot user.
Takes the following named parameters:
bot- Bot user to get info on (string, optional)
Resolves to a structure representing the response.
calls_add
Registers a new Call.
Takes the following named parameters:
external_unique_id- An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. (string, required)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. (string, optional)join_url- The URL required for a client to join the Call. (string, required)desktop_app_join_url- When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. (string, optional)date_start- Call start time in UTC UNIX timestamp format (integer, optional)title- The name of the Call. (string, optional)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. (string, optional)users- The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users). (string, optional)
Resolves to a structure representing the response.
calls_end
Ends a Call.
Takes the following named parameters:
id- `id` returned when registering the call using the [`calls.add`](/methods/calls.add) method. (string, required)duration- Call duration in seconds (integer, optional)
Resolves to a structure representing the response.
calls_info
Returns information about a Call.
Takes the following named parameters:
id- `id` of the Call returned by the [`calls.add`](/methods/calls.add) method. (string, required)
Resolves to a structure representing the response.
calls_participants_add
Registers new participants added to a Call.
Takes the following named parameters:
id- `id` returned by the [`calls.add`](/methods/calls.add) method. (string, required)users- The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users). (string, required)
Resolves to a structure representing the response.
calls_participants_remove
Registers participants removed from a Call.
Takes the following named parameters:
id- `id` returned by the [`calls.add`](/methods/calls.add) method. (string, required)users- The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users). (string, required)
Resolves to a structure representing the response.
calls_update
Updates information about a Call.
Takes the following named parameters:
id- `id` returned by the [`calls.add`](/methods/calls.add) method. (string, required)title- The name of the Call. (string, optional)join_url- The URL required for a client to join the Call. (string, optional)desktop_app_join_url- When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. (string, optional)
Resolves to a structure representing the response.
chat_delete
Deletes a message.
Takes the following named parameters:
ts- Timestamp of the message to be deleted. (number, optional)channel- Channel containing the message to be deleted. (string, optional)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. (boolean, optional)
Resolves to a structure representing the response.
chat_delete_scheduled_message
Deletes a pending scheduled message from the queue.
Takes the following named parameters:
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. (boolean, optional)channel- The channel the scheduled_message is posting to (string, required)scheduled_message_id- `scheduled_message_id` returned from call to chat.scheduleMessage (string, required)
Resolves to a structure representing the response.
chat_get_permalink
Retrieve a permalink URL for a specific extant message
Takes the following named parameters:
channel- The ID of the conversation or channel containing the message (string, required)message_ts- A message's `ts` value, uniquely identifying it within a channel (string, required)
Resolves to a structure representing the response.
chat_me_message
Share a me message into a channel.
Takes the following named parameters:
channel- Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name. (string, optional)text- Text of the message to send. (string, optional)
Resolves to a structure representing the response.
chat_post_ephemeral
Sends an ephemeral message to a user in a channel.
Takes the following named parameters:
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. (boolean, optional)attachments- A JSON-based array of structured attachments, presented as a URL-encoded string. (string, optional)blocks- A JSON-based array of structured blocks, presented as a URL-encoded string. (string, optional)channel- Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. (string, required)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. (string, optional)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. (string, optional)link_names- Find and link channel names and usernames. (boolean, optional)parse- Change how messages are treated. Defaults to `none`. See [below](#formatting). (string, optional)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. (string, optional)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. (string, optional)user- `id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument. (string, required)username- Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. (string, optional)
Resolves to a structure representing the response.
chat_post_message
Sends a message to a channel.
Takes the following named parameters:
as_user- Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below. (string, optional)attachments- A JSON-based array of structured attachments, presented as a URL-encoded string. (string, optional)blocks- A JSON-based array of structured blocks, presented as a URL-encoded string. (string, optional)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. (string, required)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. (string, optional)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. (string, optional)link_names- Find and link channel names and usernames. (boolean, optional)mrkdwn- Disable Slack markup parsing by setting to `false`. Enabled by default. (boolean, optional)parse- Change how messages are treated. Defaults to `none`. See [below](#formatting). (string, optional)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`. (boolean, optional)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. (string, optional)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. (string, optional)unfurl_links- Pass true to enable unfurling of primarily text-based content. (boolean, optional)unfurl_media- Pass false to disable unfurling of media content. (boolean, optional)username- Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. (string, optional)
Resolves to a structure representing the response.
chat_schedule_message
Schedules a message to be sent to a channel.
Takes the following named parameters:
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. (string, optional)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. (string, optional)post_at- Unix EPOCH timestamp of time in future to send the message. (string, optional)parse- Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting). (string, optional)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). (boolean, optional)link_names- Find and link channel names and usernames. (boolean, optional)attachments- A JSON-based array of structured attachments, presented as a URL-encoded string. (string, optional)blocks- A JSON-based array of structured blocks, presented as a URL-encoded string. (string, optional)unfurl_links- Pass true to enable unfurling of primarily text-based content. (boolean, optional)unfurl_media- Pass false to disable unfurling of media content. (boolean, optional)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. (number, optional)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`. (boolean, optional)
Resolves to a structure representing the response.
chat_scheduled_messages_list
Returns a list of scheduled messages.
Takes the following named parameters:
channel- The channel of the scheduled messages (string, optional)latest- A UNIX timestamp of the latest value in the time range (number, optional)oldest- A UNIX timestamp of the oldest value in the time range (number, optional)limit- Maximum number of original entries to return. (integer, optional)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. (string, optional)
Resolves to a structure representing the response.
chat_unfurl
Provide custom unfurl behavior for user-posted URLs
Takes the following named parameters:
channel- Channel ID of the message (string, required)ts- Timestamp of the message to add unfurl behavior to. (string, required)unfurls- URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. (string, optional)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 (string, optional)user_auth_required- Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain (boolean, optional)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. (string, optional)
Resolves to a structure representing the response.
chat_update
Updates a message.
Takes the following named parameters:
as_user- Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users. (string, optional)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. (string, optional)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. (string, optional)channel- Channel containing the message to be updated. (string, required)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`. (string, optional)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`. (string, optional)text- New text for the message, using the [default formatting rules](/reference/surfaces/formatting). It's not required when presenting `blocks` or `attachments`. (string, optional)ts- Timestamp of the message to be updated. (string, required)
Resolves to a structure representing the response.
conversations_archive
Archives a conversation.
Takes the following named parameters:
channel- ID of conversation to archive (string, optional)
Resolves to a structure representing the response.
conversations_close
Closes a direct message or multi-person direct message.
Takes the following named parameters:
channel- Conversation to close. (string, optional)
Resolves to a structure representing the response.
conversations_create
Initiates a public or private channel-based conversation
Takes the following named parameters:
name- Name of the public or private channel to create (string, optional)is_private- Create a private channel instead of a public one (boolean, optional)
Resolves to a structure representing the response.
conversations_history
Fetches a conversation's history of messages and events.
Takes the following named parameters:
channel- Conversation ID to fetch history for. (string, optional)latest- End of time range of messages to include in results. (number, optional)oldest- Start of time range of messages to include in results. (number, optional)inclusive- Include messages with latest or oldest timestamp in results only when either timestamp is specified. (boolean, optional)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. (integer, optional)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. (string, optional)
Resolves to a structure representing the response.
conversations_info
Retrieve information about a conversation.
Takes the following named parameters:
channel- Conversation ID to learn more about (string, optional)include_locale- Set this to `true` to receive the locale for this conversation. Defaults to `false` (boolean, optional)include_num_members- Set to `true` to include the member count for the specified conversation. Defaults to `false` (boolean, optional)
Resolves to a structure representing the response.
conversations_invite
Invites users to a channel.
Takes the following named parameters:
channel- The ID of the public or private channel to invite user(s) to. (string, optional)users- A comma separated list of user IDs. Up to 1000 users may be listed. (string, optional)
Resolves to a structure representing the response.
conversations_join
Joins an existing conversation.
Takes the following named parameters:
channel- ID of conversation to join (string, optional)
Resolves to a structure representing the response.
conversations_kick
Removes a user from a conversation.
Takes the following named parameters:
channel- ID of conversation to remove user from. (string, optional)user- User ID to be removed. (string, optional)
Resolves to a structure representing the response.
conversations_leave
Leaves a conversation.
Takes the following named parameters:
channel- Conversation to leave (string, optional)
Resolves to a structure representing the response.
conversations_list
Lists all channels in a Slack team.
Takes the following named parameters:
exclude_archived- Set to `true` to exclude archived channels from the list (boolean, optional)types- Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im` (string, optional)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. (integer, optional)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. (string, optional)
Resolves to a structure representing the response.
conversations_mark
Sets the read cursor in a channel.
Takes the following named parameters:
channel- Channel or conversation to set the read cursor for. (string, optional)ts- Unique identifier of message you want marked as most recently seen in this conversation. (number, optional)
Resolves to a structure representing the response.
conversations_members
Retrieve members of a conversation.
Takes the following named parameters:
channel- ID of the conversation to retrieve members for (string, optional)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. (integer, optional)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. (string, optional)
Resolves to a structure representing the response.
conversations_open
Opens or resumes a direct message or multi-person direct message.
Takes the following named parameters:
channel- Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead. (string, optional)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`. (string, optional)return_im- Boolean, indicates you want the full IM channel definition in the response. (boolean, optional)
Resolves to a structure representing the response.
conversations_rename
Renames a conversation.
Takes the following named parameters:
channel- ID of conversation to rename (string, optional)name- New name for conversation. (string, optional)
Resolves to a structure representing the response.
conversations_replies
Retrieve a thread of messages posted to a conversation
Takes the following named parameters:
channel- Conversation ID to fetch thread from. (string, optional)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. (number, optional)latest- End of time range of messages to include in results. (number, optional)oldest- Start of time range of messages to include in results. (number, optional)inclusive- Include messages with latest or oldest timestamp in results only when either timestamp is specified. (boolean, optional)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. (integer, optional)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. (string, optional)
Resolves to a structure representing the response.
conversations_set_purpose
Sets the purpose for a conversation.
Takes the following named parameters:
channel- Conversation to set the purpose of (string, optional)purpose- A new, specialer purpose (string, optional)
Resolves to a structure representing the response.
conversations_set_topic
Sets the topic for a conversation.
Takes the following named parameters:
channel- Conversation to set the topic of (string, optional)topic- The new topic string. Does not support formatting or linkification. (string, optional)
Resolves to a structure representing the response.
conversations_unarchive
Reverses conversation archival.
Takes the following named parameters:
channel- ID of conversation to unarchive (string, optional)
Resolves to a structure representing the response.
dialog_open
Open a dialog with a user
Takes the following named parameters:
dialog- The dialog definition. This must be a JSON-encoded string. (string, required)trigger_id- Exchange a trigger to post to the user. (string, required)
Resolves to a structure representing the response.
dnd_end_dnd
Ends the current user's Do Not Disturb session immediately.
Resolves to a structure representing the response.
dnd_end_snooze
Ends the current user's snooze mode immediately.
Resolves to a structure representing the response.
dnd_info
Retrieves a user's current Do Not Disturb status.
Takes the following named parameters:
user- User to fetch status for (defaults to current user) (string, optional)
Resolves to a structure representing the response.
dnd_set_snooze
Turns on Do Not Disturb mode for the current user, or changes its duration.
Takes the following named parameters:
num_minutes- Number of minutes, from now, to snooze until. (string, required)
Resolves to a structure representing the response.
dnd_team_info
Retrieves the Do Not Disturb status for up to 50 users on a team.
Takes the following named parameters:
users- Comma-separated list of users to fetch Do Not Disturb status for (string, optional)
Resolves to a structure representing the response.
emoji_list
Lists custom emoji for a team.
Resolves to a structure representing the response.
files_comments_delete
Deletes an existing comment on a file.
Takes the following named parameters:
file- File to delete a comment from. (string, optional)id- The comment to delete. (string, optional)
Resolves to a structure representing the response.
files_delete
Deletes a file.
Takes the following named parameters:
file- ID of file to delete. (string, optional)
Resolves to a structure representing the response.
files_info
Gets information about a file.
Takes the following named parameters:
file- Specify a file by providing its ID. (string, optional)count- (string, optional)page- (string, optional)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. (integer, optional)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. (string, optional)
Resolves to a structure representing the response.
files_list
List for a team, in a channel, or from a user with applied filters.
Takes the following named parameters:
user- Filter files created by a single user. (string, optional)channel- Filter files appearing in a specific channel, indicated by its ID. (string, optional)ts_from- Filter files created after this timestamp (inclusive). (number, optional)ts_to- Filter files created before this timestamp (inclusive). (number, optional)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. (string, optional)count- (string, optional)page- (string, optional)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. (boolean, optional)
Resolves to a structure representing the response.
files_remote_add
Adds a file from a remote service
Takes the following named parameters:
external_id- Creator defined GUID for the file. (string, optional)title- Title of the file being shared. (string, optional)filetype- type of file (string, optional)external_url- URL of the remote file. (string, optional)preview_image- Preview of the document via `multipart/form-data`. (string, optional)indexable_file_contents- A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file. (string, optional)
Resolves to a structure representing the response.
files_remote_info
Retrieve information about a remote file added to Slack
Takes the following named parameters:
file- Specify a file by providing its ID. (string, optional)external_id- Creator defined GUID for the file. (string, optional)
Resolves to a structure representing the response.
files_remote_list
Retrieve information about a remote file added to Slack
Takes the following named parameters:
channel- Filter files appearing in a specific channel, indicated by its ID. (string, optional)ts_from- Filter files created after this timestamp (inclusive). (number, optional)ts_to- Filter files created before this timestamp (inclusive). (number, optional)limit- The maximum number of items to return. (integer, optional)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. (string, optional)
Resolves to a structure representing the response.
files_remote_remove
Remove a remote file.
Takes the following named parameters:
file- Specify a file by providing its ID. (string, optional)external_id- Creator defined GUID for the file. (string, optional)
Resolves to a structure representing the response.
files_remote_share
Share a remote file into a channel.
Takes the following named parameters:
file- Specify a file registered with Slack by providing its ID. Either this field or `external_id` or both are required. (string, optional)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. (string, optional)channels- Comma-separated list of channel IDs where the file will be shared. (string, optional)
Resolves to a structure representing the response.
files_remote_update
Updates an existing remote file.
Takes the following named parameters:
file- Specify a file by providing its ID. (string, optional)external_id- Creator defined GUID for the file. (string, optional)title- Title of the file being shared. (string, optional)filetype- type of file (string, optional)external_url- URL of the remote file. (string, optional)preview_image- Preview of the document via `multipart/form-data`. (string, optional)indexable_file_contents- File containing contents that can be used to improve searchability for the remote file. (string, optional)
Resolves to a structure representing the response.
files_revoke_public_url
Revokes public/external sharing access for a file
Takes the following named parameters:
file- File to revoke (string, optional)
Resolves to a structure representing the response.
files_shared_public_url
Enables a file for public/external sharing.
Takes the following named parameters:
file- File to share (string, optional)
Resolves to a structure representing the response.
migration_exchange
For Enterprise Grid workspaces, map local user IDs to global user IDs
Takes the following named parameters:
users- A comma-separated list of user ids, up to 400 per request (string, required)team_id- Specify team_id starts with `T` in case of Org Token (string, optional)to_old- Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`. (boolean, optional)
Resolves to a structure representing the response.
oauth_access
Exchanges a temporary OAuth verifier code for an access token.
Takes the following named parameters:
client_id- Issued when you created your application. (string, optional)client_secret- Issued when you created your application. (string, optional)code- The `code` param returned via the OAuth callback. (string, optional)redirect_uri- This must match the originally submitted URI (if one was sent). (string, optional)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). (boolean, optional)
Resolves to a structure representing the response.
oauth_token
Exchanges a temporary OAuth verifier code for a workspace token.
Takes the following named parameters:
client_id- Issued when you created your application. (string, optional)client_secret- Issued when you created your application. (string, optional)code- The `code` param returned via the OAuth callback. (string, optional)redirect_uri- This must match the originally submitted URI (if one was sent). (string, optional)single_channel- Request the user to add your app only to a single channel. (boolean, optional)
Resolves to a structure representing the response.
oauth_v2_access
Exchanges a temporary OAuth verifier code for an access token.
Takes the following named parameters:
client_id- Issued when you created your application. (string, optional)client_secret- Issued when you created your application. (string, optional)code- The `code` param returned via the OAuth callback. (string, required)redirect_uri- This must match the originally submitted URI (if one was sent). (string, optional)
Resolves to a structure representing the response.
pins_add
Pins an item to a channel.
Takes the following named parameters:
channel- Channel to pin the item in. (string, required)timestamp- Timestamp of the message to pin. (string, optional)
Resolves to a structure representing the response.
pins_list
Lists items pinned to a channel.
Takes the following named parameters:
channel- Channel to get pinned items for. (string, required)
Resolves to a structure representing the response.
pins_remove
Un-pins an item from a channel.
Takes the following named parameters:
channel- Channel where the item is pinned to. (string, required)timestamp- Timestamp of the message to un-pin. (string, optional)
Resolves to a structure representing the response.
reactions_add
Adds a reaction to an item.
Takes the following named parameters:
channel- Channel where the message to add reaction to was posted. (string, required)name- Reaction (emoji) name. (string, required)timestamp- Timestamp of the message to add reaction to. (string, required)
Resolves to a structure representing the response.
reactions_get
Gets reactions for an item.
Takes the following named parameters:
channel- Channel where the message to get reactions for was posted. (string, optional)file- File to get reactions for. (string, optional)file_comment- File comment to get reactions for. (string, optional)full- If true always return the complete reaction list. (boolean, optional)timestamp- Timestamp of the message to get reactions for. (string, optional)
Resolves to a structure representing the response.
reactions_list
Lists reactions made by a user.
Takes the following named parameters:
user- Show reactions made by this user. Defaults to the authed user. (string, optional)full- If true always return the complete reaction list. (boolean, optional)count- (integer, optional)page- (integer, optional)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. (string, optional)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. (integer, optional)
Resolves to a structure representing the response.
reactions_remove
Removes a reaction from an item.
Takes the following named parameters:
name- Reaction (emoji) name. (string, required)file- File to remove reaction from. (string, optional)file_comment- File comment to remove reaction from. (string, optional)channel- Channel where the message to remove reaction from was posted. (string, optional)timestamp- Timestamp of the message to remove reaction from. (string, optional)
Resolves to a structure representing the response.
reminders_add
Creates a reminder.
Takes the following named parameters:
text- The content of the reminder (string, required)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") (string, required)user- The user who will receive the reminder. If no user is specified, the reminder will go to user who created it. (string, optional)
Resolves to a structure representing the response.
reminders_complete
Marks a reminder as complete.
Takes the following named parameters:
reminder- The ID of the reminder to be marked as complete (string, optional)
Resolves to a structure representing the response.
reminders_delete
Deletes a reminder.
Takes the following named parameters:
reminder- The ID of the reminder (string, optional)
Resolves to a structure representing the response.
reminders_info
Gets information about a reminder.
Takes the following named parameters:
reminder- The ID of the reminder (string, optional)
Resolves to a structure representing the response.
reminders_list
Lists all reminders created by or for a given user.
Resolves to a structure representing the response.
rtm_connect
Starts a Real Time Messaging session.
Takes the following named parameters:
batch_presence_aware- Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching). (boolean, optional)presence_sub- Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions). (boolean, optional)
Resolves to a structure representing the response.
search_messages
Searches for messages matching a query.
Takes the following named parameters:
count- Pass the number of results you want per "page". Maximum of `100`. (integer, optional)highlight- Pass a value of `true` to enable query highlight markers (see below). (boolean, optional)page- (integer, optional)query- Search query. (string, required)sort- Return matches sorted by either `score` or `timestamp`. (string, optional)sort_dir- Change sort direction to ascending (`asc`) or descending (`desc`). (string, optional)
Resolves to a structure representing the response.
stars_add
Adds a star to an item.
Takes the following named parameters:
channel- Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`). (string, optional)file- File to add star to. (string, optional)file_comment- File comment to add star to. (string, optional)timestamp- Timestamp of the message to add star to. (string, optional)
Resolves to a structure representing the response.
stars_list
Lists stars for a user.
Takes the following named parameters:
count- (string, optional)page- (string, optional)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. (string, optional)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. (integer, optional)
Resolves to a structure representing the response.
stars_remove
Removes a star from an item.
Takes the following named parameters:
channel- Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`). (string, optional)file- File to remove star from. (string, optional)file_comment- File comment to remove star from. (string, optional)timestamp- Timestamp of the message to remove star from. (string, optional)
Resolves to a structure representing the response.
team_access_logs
Gets the access logs for the current team.
Takes the following named parameters:
before- End of time range of logs to include in results (inclusive). (string, optional)count- (string, optional)page- (string, optional)
Resolves to a structure representing the response.
team_billable_info
Gets billable users information for the current team.
Takes the following named parameters:
user- A user to retrieve the billable information for. Defaults to all users. (string, optional)
Resolves to a structure representing the response.
team_info
Gets information about the current team.
Takes the following named parameters:
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 (string, optional)
Resolves to a structure representing the response.
team_integration_logs
Gets the integration logs for the current team.
Takes the following named parameters:
app_id- Filter logs to this Slack app. Defaults to all logs. (string, optional)change_type- Filter logs with this change type. Defaults to all logs. (string, optional)count- (string, optional)page- (string, optional)service_id- Filter logs to this service. Defaults to all logs. (string, optional)user- Filter logs generated by this user’s actions. Defaults to all logs. (string, optional)
Resolves to a structure representing the response.
team_profile_get
Retrieve a team's profile.
Takes the following named parameters:
visibility- Filter by visibility. (string, optional)
Resolves to a structure representing the response.
usergroups_create
Create a User Group
Takes the following named parameters:
channels- A comma separated string of encoded channel IDs for which the User Group uses as a default. (string, optional)description- A short description of the User Group. (string, optional)handle- A mention handle. Must be unique among channels, users and User Groups. (string, optional)include_count- Include the number of users in each User Group. (boolean, optional)name- A name for the User Group. Must be unique among User Groups. (string, required)
Resolves to a structure representing the response.
usergroups_disable
Disable an existing User Group
Takes the following named parameters:
include_count- Include the number of users in the User Group. (boolean, optional)usergroup- The encoded ID of the User Group to disable. (string, required)
Resolves to a structure representing the response.
usergroups_enable
Enable a User Group
Takes the following named parameters:
include_count- Include the number of users in the User Group. (boolean, optional)usergroup- The encoded ID of the User Group to enable. (string, required)
Resolves to a structure representing the response.
usergroups_list
List all User Groups for a team
Takes the following named parameters:
include_users- Include the list of users for each User Group. (boolean, optional)include_count- Include the number of users in each User Group. (boolean, optional)include_disabled- Include disabled User Groups. (boolean, optional)
Resolves to a structure representing the response.
usergroups_update
Update an existing User Group
Takes the following named parameters:
handle- A mention handle. Must be unique among channels, users and User Groups. (string, optional)description- A short description of the User Group. (string, optional)channels- A comma separated string of encoded channel IDs for which the User Group uses as a default. (string, optional)include_count- Include the number of users in the User Group. (boolean, optional)usergroup- The encoded ID of the User Group to update. (string, required)name- A name for the User Group. Must be unique among User Groups. (string, optional)
Resolves to a structure representing the response.
usergroups_users_list
List all users in a User Group
Takes the following named parameters:
include_disabled- Allow results that involve disabled User Groups. (boolean, optional)usergroup- The encoded ID of the User Group to update. (string, required)
Resolves to a structure representing the response.
usergroups_users_update
Update the list of users for a User Group
Takes the following named parameters:
include_count- Include the number of users in the User Group. (boolean, optional)usergroup- The encoded ID of the User Group to update. (string, required)users- A comma separated string of encoded user IDs that represent the entire list of users for the User Group. (string, required)
Resolves to a structure representing the response.
users_conversations
List conversations the calling user may access.
Takes the following named parameters:
user- Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership. (string, optional)types- Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im` (string, optional)exclude_archived- Set to `true` to exclude archived channels from the list (boolean, optional)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. (integer, optional)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. (string, optional)
Resolves to a structure representing the response.
users_delete_photo
Delete the user profile photo
Resolves to a structure representing the response.
users_get_presence
Gets user presence information.
Takes the following named parameters:
user- User to get presence info on. Defaults to the authed user. (string, optional)
Resolves to a structure representing the response.
users_identity
Get a user's identity.
Resolves to a structure representing the response.
users_info
Gets information about a user.
Takes the following named parameters:
include_locale- Set this to `true` to receive the locale for this user. Defaults to `false` (boolean, optional)user- User to get info on (string, optional)
Resolves to a structure representing the response.
users_list
Lists all users in a Slack team.
Takes the following named parameters:
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. (integer, optional)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. (string, optional)include_locale- Set this to `true` to receive the locale for users. Defaults to `false` (boolean, optional)
Resolves to a structure representing the response.
users_lookup_by_email
Find a user with an email address.
Takes the following named parameters:
email- An email address belonging to a user in the workspace (string, required)
Resolves to a structure representing the response.
users_profile_get
Retrieves a user's profile information.
Takes the following named parameters:
include_labels- Include labels for each ID in custom profile fields (boolean, optional)user- User to retrieve profile info for (string, optional)
Resolves to a structure representing the response.
users_profile_set
Set the profile information for a user.
Takes the following named parameters:
name- Name of a single key to set. Usable only if `profile` is not passed. (string, optional)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. (string, optional)user- ID of user to change. This argument may only be specified by team admins on paid teams. (string, optional)value- Value to set a single key to. Usable only if `profile` is not passed. (string, optional)
Resolves to a structure representing the response.
users_set_active
Marked a user as active. Deprecated and non-functional.
Resolves to a structure representing the response.
users_set_photo
Set the user profile photo
Takes the following named parameters:
crop_w- Width/height of crop box (always square) (string, optional)crop_x- X coordinate of top-left corner of crop box (string, optional)crop_y- Y coordinate of top-left corner of crop box (string, optional)image- File contents via `multipart/form-data`. (string, optional)
Resolves to a structure representing the response.
users_set_presence
Manually sets user presence.
Takes the following named parameters:
presence- Either `auto` or `away` (string, required)
Resolves to a structure representing the response.
views_open
Open a view for a user.
Takes the following named parameters:
trigger_id- Exchange a trigger to post to the user. (string, required)view- A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. (string, required)
Resolves to a structure representing the response.
views_publish
Publish a static view for a User.
Takes the following named parameters:
user_id- `id` of the user you want publish a view to. (string, required)view- A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. (string, required)hash- A string that represents view state to protect against possible race conditions. (string, optional)
Resolves to a structure representing the response.
views_push
Push a view onto the stack of a root view.
Takes the following named parameters:
trigger_id- Exchange a trigger to post to the user. (string, required)view- A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. (string, required)
Resolves to a structure representing the response.
views_update
Update an existing view.
Takes the following named parameters:
view_id- A unique identifier of the view to be updated. Either `view_id` or `external_id` is required. (string, optional)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. (string, optional)view- A [view object](/reference/surfaces/views). This must be a JSON-encoded string. (string, optional)hash- A string that represents view state to protect against possible race conditions. (string, optional)
Resolves to a structure representing the response.
workflows_step_completed
Indicate that an app's step in a workflow completed execution.
Takes the following named parameters:
workflow_step_execute_id- Context identifier that maps to the correct workflow step execution. (string, required)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. (string, optional)
Resolves to a structure representing the response.
workflows_step_failed
Indicate that an app's step in a workflow failed to execute.
Takes the following named parameters:
workflow_step_execute_id- Context identifier that maps to the correct workflow step execution. (string, required)error- A JSON-based object with a `message` property that should contain a human readable error message. (string, required)
Resolves to a structure representing the response.
workflows_update_step
Update the configuration for a workflow extension step.
Takes the following named parameters:
workflow_step_edit_id- A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`. (string, required)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). (string, optional)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. (string, optional)step_name- An optional field that can be used to override the step name that is shown in the Workflow Builder. (string, optional)step_image_url- An optional field that can be used to override app image that is shown in the Workflow Builder. (string, optional)
Resolves to a structure representing the response.