add_reaction
Adds a reaction to an item. See https://api.slack.com/methods/reactions.add for more information.
Parameters
channel
Channel where the message to add reaction to was posted.
Type: STRING
file
File to add reaction to.
Type: STRING
file_comment
File comment to add reaction to.
Type: STRING
name
Reaction (emoji) name.
Type: STRING
timestamp
Timestamp of the message to add reaction to.
Type: NUMBER
add_reminder
Creates a reminder. See https://api.slack.com/methods/reminders.add for more information.
Parameters
text
The content of the reminder
Type: STRING
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")
Type: STRING
user
The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.
Type: STRING
add_star
Adds a star to an item. See https://api.slack.com/methods/stars.add for more information.
Parameters
channel
Channel to add star to, or channel where the message to add star to was posted (used with timestamp
).
Type: STRING
file
File to add star to.
Type: STRING
file_comment
File comment to add star to.
Type: STRING
timestamp
Timestamp of the message to add star to.
Type: NUMBER
archive_conversation
Archives a conversation. See https://api.slack.com/methods/conversations.archive for more information.
Parameters
channel
ID of conversation to archive
Type: STRING
close_conversation
Closes a direct message or multi-person direct message. See https://api.slack.com/methods/conversations.close for more information.
Parameters
channel
Conversation to close.
Type: STRING
connect_rtm
Starts a Real Time Messaging session. See https://api.slack.com/methods/rtm.connect for more information.
Parameters
batch_presence_aware
Batch presence deliveries via subscription. Enabling changes the shape of presence_change
events. See batch presence.
Type: BOOLEAN
presence_sub
Only deliver presence events when requested by subscription. See presence subscriptions.
Type: BOOLEAN
create_conversation
Initiates a public or private channel-based conversation. See https://api.slack.com/methods/conversations.create for more information.
Parameters
is_private
Create a private channel instead of a public one
Type: BOOLEAN
name
Name of the public or private channel to create
Type: STRING
create_pinned_message
Pins an item to a channel. See https://api.slack.com/methods/pins.add for more information.
Parameters
channel
Channel to pin the item in.
Type: STRING
file
File to pin.
Type: STRING
file_comment
File comment to pin.
Type: STRING
timestamp
Timestamp of the message to pin.
Type: NUMBER
create_usergroup
Create a User Group. See https://api.slack.com/methods/usergroups.create for more information.
Parameters
channels
A comma separated string of encoded channel IDs for which the User Group uses as a default.
Type: STRING
description
A short description of the User Group.
Type: STRING
handle
A mention handle. Must be unique among channels, users and User Groups.
Type: STRING
include_count
Include the number of users in each User Group.
Type: BOOLEAN
name
A name for the User Group. Must be unique among User Groups.
Type: STRING
delete_comment_on_file
Deletes an existing comment on a file. See https://api.slack.com/methods/files.comments.delete for more information.
Parameters
file
File to delete a comment from.
Type: STRING
id
The comment to delete.
Type: STRING
delete_file
Deletes a file. See https://api.slack.com/methods/files.delete for more information.
Parameters
file
ID of file to delete.
Type: STRING
delete_message
Deletes a message. See https://api.slack.com/methods/chat.delete for more information.
Parameters
as_user
Pass true to delete the message as the authed user with chat:write:user
scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot
scope.
Type: BOOLEAN
channel
Channel containing the message to be deleted.
Type: STRING
ts
Timestamp of the message to be deleted.
Type: STRING
delete_photo_for_user
Delete the user profile photo. See https://api.slack.com/methods/users.deletePhoto for more information.
This operation has no parameters
delete_reminder
Deletes a reminder. See https://api.slack.com/methods/reminders.delete for more information.
Parameters
reminder
The ID of the reminder
Type: STRING
delete_scheduled_message
Deletes a pending scheduled message from the queue. See https://api.slack.com/methods/chat.deleteScheduledMessage for more information.
Parameters
as_user
Pass true to delete the message as the authed user with chat:write:user
scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot
scope.
Type: BOOLEAN
channel
The channel the scheduled_message is posting to.
Type: STRING
scheduled_message_id
scheduled_message_id returned from call to chat.scheduleMessage.
Type: STRING
disable_usergroup
Disable an existing User Group. See https://api.slack.com/methods/usergroups.disable for more information.
Parameters
include_count
Include the number of users in the User Group.
Type: BOOLEAN
usergroup
The encoded ID of the User Group to disable.
Type: STRING
enable_public_url_for_file
Enables a file for public/external sharing. See https://api.slack.com/methods/files.sharedPublicURL for more information.
Parameters
file
File to share
Type: STRING
enable_usergroup
Enable a User Group. See https://api.slack.com/methods/usergroups.enable for more information.
Parameters
include_count
Include the number of users in the User Group.
Type: BOOLEAN
usergroup
The encoded ID of the User Group to enable.
Type: STRING
end_dnd_for_user
Ends the current user's Do Not Disturb session immediately. See https://api.slack.com/methods/dnd.endDnd for more information.
This operation has no parameters
end_dnd_snooze_for_user
Ends the current user's snooze mode immediately. See https://api.slack.com/methods/dnd.endSnooze for more information.
This operation has no parameters
exchange_migration
For Enterprise Grid workspaces, map local user IDs to global user IDs. See https://api.slack.com/methods/migration.exchange for more information.
Parameters
to_old
Specify true
to convert W
global user IDs to workspace-specific U
IDs. Defaults to false
.
Type: BOOLEAN
users
A comma-separated list of user ids, up to 400 per request
Type: STRING
get_access_logs
Gets the access logs for the current team. See https://api.slack.com/methods/team.accessLogs for more information.
Parameters
before
End of time range of logs to include in results (inclusive).
Type: INTEGER
get_authenticated_user
Checks authentication & identity. See https://api.slack.com/methods/auth.test for more information.
This operation has no parameters
get_billable_users_info
Gets billable users information for the current team. See https://api.slack.com/methods/team.billableInfo for more information.
Parameters
user
A user to retrieve the billable information for. Defaults to all users.
Type: STRING
get_dnd_for_user
Retrieves a user's current Do Not Disturb status. See https://api.slack.com/methods/dnd.info for more information.
Parameters
user
User to fetch status for (defaults to current user)
Type: STRING
get_identity_for_user
Get a user's identity. See https://api.slack.com/methods/users.identity for more information.
This operation has no parameters
get_info_for_bot
Gets information about a bot user. See https://api.slack.com/methods/bots.info for more information.
Parameters
bot
Bot user to get info on
Type: STRING
get_info_for_conversation
Retrieve information about a conversation. See https://api.slack.com/methods/conversations.info for more information.
Parameters
channel
Conversation ID to learn more about
Type: STRING
include_locale
Set this to true
to receive the locale for this conversation. Defaults to false
Type: BOOLEAN
get_info_for_reminder
Gets information about a reminder. See https://api.slack.com/methods/reminders.info for more information.
Parameters
reminder
The ID of the reminder
Type: STRING
get_info_for_user
Gets information about a user. See https://api.slack.com/methods/users.info for more information.
Parameters
include_locale
Set this to true
to receive the locale for this user. Defaults to false
Type: BOOLEAN
user
User to get info on
Type: STRING
get_info_on_file
Gets information about a team file. See https://api.slack.com/methods/files.info for more information.
Parameters
file
Specify a file by providing its ID.
Type: STRING
page
Type: STRING
get_integration_logs
Gets the integration logs for the current team. See https://api.slack.com/methods/team.integrationLogs for more information.
Parameters
app_id
Filter logs to this Slack app. Defaults to all logs.
Type: INTEGER
change_type
Filter logs with this change type. Defaults to all logs.
Type: STRING
service_id
Filter logs to this service. Defaults to all logs.
Type: INTEGER
user
Filter logs generated by this user’s actions. Defaults to all logs.
Type: STRING
get_oauth_access
Exchanges a temporary OAuth verifier code for an access token. See https://api.slack.com/methods/oauth.access for more information.
Parameters
client_id
Issued when you created your application.
Type: STRING
client_secret
Issued when you created your application.
Type: STRING
code
The code
param returned via the OAuth callback.
Type: STRING
redirect_uri
This must match the originally submitted URI (if one was sent).
Type: STRING
single_channel
Request the user to add your app only to a single channel.
Type: BOOLEAN
get_oauth_token
Exchanges a temporary OAuth verifier code for a workspace token. See https://api.slack.com/methods/oauth.token for more information.
Parameters
client_id
Issued when you created your application.
Type: STRING
client_secret
Issued when you created your application.
Type: STRING
code
The code
param returned via the OAuth callback.
Type: STRING
redirect_uri
This must match the originally submitted URI (if one was sent).
Type: STRING
single_channel
Request the user to add your app only to a single channel.
Type: BOOLEAN
get_permalink_for_message
Retrieve a permalink URL for a specific extant message. See https://api.slack.com/methods/chat.getPermalink for more information.
Parameters
channel
The ID of the conversation or channel containing the message
Type: STRING
message_ts
A message's ts
value, uniquely identifying it within a channel
Type: STRING
get_permissions_for_app
Returns list of permissions this app has on a team. See https://api.slack.com/methods/apps.permissions.info for more information.
This operation has no parameters
get_presence_for_user
Gets user presence information. See https://api.slack.com/methods/users.getPresence for more information.
Parameters
user
User to get presence info on. Defaults to the authed user.
Type: STRING
get_profile_for_user
Retrieves a user's profile information. See https://api.slack.com/methods/users.profile.get for more information.
Parameters
include_labels
Include labels for each ID in custom profile fields
Type: BOOLEAN
user
User to retrieve profile info for
Type: STRING
get_reactions
Gets reactions for an item. See https://api.slack.com/methods/reactions.get for more information.
Parameters
channel
Channel where the message to get reactions for was posted.
Type: STRING
file
File to get reactions for.
Type: STRING
file_comment
File comment to get reactions for.
Type: STRING
full
If true always return the complete reaction list.
Type: BOOLEAN
timestamp
Timestamp of the message to get reactions for.
Type: NUMBER
get_team_info
Gets information about the current team. See https://api.slack.com/methods/team.info for more information.
This operation has no parameters
get_team_profile
Retrieve a team's profile. See https://api.slack.com/methods/team.profile.get for more information.
Parameters
visibility
Filter by visibility.
Type: STRING
invite_user_to_conversation
Invites users to a channel. See https://api.slack.com/methods/conversations.invite for more information.
Parameters
channel
The ID of the public or private channel to invite user(s) to.
Type: STRING
users
A comma separated list of user IDs. Up to 30 users may be listed.
Type: STRING
join_conversation
Joins an existing conversation. See https://api.slack.com/methods/conversations.join for more information.
Parameters
channel
ID of conversation to join
Type: STRING
leave_conversation
Leaves a conversation. See https://api.slack.com/methods/conversations.leave for more information.
Parameters
channel
Conversation to leave
Type: STRING
list_conversations
Lists all channels in a Slack team. See https://api.slack.com/methods/conversations.list for more information.
Parameters
exclude_archived
Set to true
to exclude archived channels from the list
Type: BOOLEAN
types
Mix and match channel types by providing a comma-separated list of any combination of public_channel
, private_channel
, mpim
, im
Type: STRING
list_conversations_for_user
List conversations the calling user may access. See https://api.slack.com/methods/users.conversations for more information.
Parameters
exclude_archived
Set to true
to exclude archived channels from the list
Type: BOOLEAN
types
Mix and match channel types by providing a comma-separated list of any combination of public_channel
, private_channel
, mpim
, im
Type: STRING
user
Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
Type: STRING
list_dnds_for_team
Retrieves the Do Not Disturb status for users on a team. See https://api.slack.com/methods/dnd.teamInfo for more information.
Parameters
users
Comma-separated list of users to fetch Do Not Disturb status for
Type: STRING
list_emojis
Lists custom emoji for a team. See https://api.slack.com/methods/emoji.list for more information.
This operation has no parameters
list_files
Lists & filters team files. See https://api.slack.com/methods/files.list for more information.
Parameters
channel
Filter files appearing in a specific channel, indicated by its ID.
Type: STRING
ts_from
Filter files created after this timestamp (inclusive).
Type: NUMBER
ts_to
Filter files created before this timestamp (inclusive).
Type: NUMBER
types
Filter files by type:
all
- All filesspaces
- Postssnippets
- Snippetsimages
- Image filesgdocs
- Google docszips
- Zip filespdfs
- PDF files
You can pass multiple values in the types argument, like types=spaces,snippets
.The default value is all
, which does not filter the list.
Type: STRING
user
Filter files created by a single user.
Type: STRING
list_history_for_conversation
Fetches a conversation's history of messages and events. See https://api.slack.com/methods/conversations.history for more information.
Parameters
channel
Conversation ID to fetch history for.
Type: STRING
inclusive
Include messages with latest or oldest timestamp in results only when either timestamp is specified.
Type: BOOLEAN
latest
End of time range of messages to include in results.
Type: NUMBER
oldest
Start of time range of messages to include in results.
Type: NUMBER
list_members
Retrieve members of a conversation. See https://api.slack.com/methods/conversations.members for more information.
Parameters
channel
ID of the conversation to retrieve members for
Type: STRING
list_pinned_messages
Lists items pinned to a channel. See https://api.slack.com/methods/pins.list for more information.
Parameters
channel
Channel to get pinned items for.
Type: STRING
list_reactions_made_by_user
Lists reactions made by a user. See https://api.slack.com/methods/reactions.list for more information.
Parameters
count
Type: STRING
full
If true always return the complete reaction list.
Type: BOOLEAN
page
Type: STRING
user
Show reactions made by this user. Defaults to the authed user.
Type: STRING
list_reminders
Lists all reminders created by or for a given user. See https://api.slack.com/methods/reminders.list for more information.
This operation has no parameters
list_replies_in_conversation
Retrieve a thread of messages posted to a conversation. See https://api.slack.com/methods/conversations.replies for more information.
Parameters
channel
Conversation ID to fetch thread from.
Type: STRING
inclusive
Include messages with latest or oldest timestamp in results only when either timestamp is specified.
Type: BOOLEAN
latest
End of time range of messages to include in results.
Type: NUMBER
oldest
Start of time range of messages to include in results.
Type: NUMBER
ts
Unique identifier of a thread's parent message.
Type: STRING
list_resources_for_app
Returns list of resource grants this app has on a team. See https://api.slack.com/methods/apps.permissions.resources.list for more information.
This operation has no parameters
list_scheduled_messages
Returns a list of scheduled messages. See https://api.slack.com/methods/chat.scheduledMessages.list for more information.
Parameters
channel
The channel of the scheduled messages.
Type: STRING
latest
A UNIX timestamp of the latest value in the time range.
Type: NUMBER
oldest
A UNIX timestamp of the oldest value in the time range.
Type: NUMBER
list_scopes_for_app
Returns list of scopes this app has on a team. See https://api.slack.com/methods/apps.permissions.scopes.list for more information.
This operation has no parameters
list_stars
Lists stars for a user. See https://api.slack.com/methods/stars.list for more information.
Parameters
count
Type: STRING
page
Type: STRING
list_usergroups
List all User Groups for a team. See https://api.slack.com/methods/usergroups.list for more information.
Parameters
include_count
Include the number of users in each User Group.
Type: BOOLEAN
include_disabled
Include disabled User Groups.
Type: BOOLEAN
include_users
Include the list of users for each User Group.
Type: BOOLEAN
list_users
Lists all users in a Slack team. See https://api.slack.com/methods/users.list for more information.
Parameters
include_locale
Set this to true
to receive the locale for users. Defaults to false
Type: BOOLEAN
presence
Deprecated. Whether to include presence data in the output. Defaults to false
. Setting this to true
reduces performance, especially with large teams.
Type: BOOLEAN
list_users_from_usergroup
List all users in a User Group. See https://api.slack.com/methods/usergroups.users.list for more information.
Parameters
include_disabled
Allow results that involve disabled User Groups.
Type: BOOLEAN
usergroup
The encoded ID of the User Group to update.
Type: STRING
lookup_user_by_email
Find a user with an email address. See https://api.slack.com/methods/users.lookupByEmail for more information.
Parameters
An email address belonging to a user in the workspace
Type: STRING
mark_reminder_as_complete
Marks a reminder as complete. See https://api.slack.com/methods/reminders.complete for more information.
Parameters
reminder
The ID of the reminder to be marked as complete
Type: STRING
open_conversation
Opens or resumes a direct message or multi-person direct message. See https://api.slack.com/methods/conversations.open for more information.
Parameters
channel
Resume a conversation by supplying an im
or mpim
's ID. Or provide the users
field instead.
Type: STRING
return_im
Boolean, indicates you want the full IM channel definition in the response.
Type: BOOLEAN
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
.
Type: STRING
open_dialog
Open a dialog with a user. See https://api.slack.com/methods/dialog.open for more information.
Parameters
dialog
The dialog definition. This must be a JSON-encoded string.
Type: STRING
trigger_id
Exchange a trigger to post to the user.
Type: STRING
open_modal_view
Open a modal with a user. See https://api.slack.com/methods/views.open for more information.
Parameters
trigger_id
Exchange a trigger to post to the user.
Type: STRING
view
The view payload. This must be a JSON-encoded string.
Type: STRING
post_message
Sends a message to a channel. See https://api.slack.com/methods/chat.postMessage for more information.
Parameters
as_user
Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
Type: BOOLEAN
attachments
A JSON-based array of structured attachments, presented as a URL-encoded string.
Type: STRING
blocks
A JSON-based array of structured blocks, presented as a URL-encoded string.
Type: STRING
channel
Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
Type: STRING
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 below.
Type: STRING
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 below.
Type: STRING
link_names
Find and link channel names and usernames.
Type: BOOLEAN
mrkdwn
Disable Slack markup parsing by setting to false
. Enabled by default.
Type: BOOLEAN
parse
Change how messages are treated. Defaults to none
. See below.
Type: STRING
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
.
Type: BOOLEAN
text
Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments
instead. Provide no more than 40,000 characters or risk truncation.
Type: STRING
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.
Type: STRING
unfurl_links
Pass true to enable unfurling of primarily text-based content.
Type: BOOLEAN
unfurl_media
Pass false to disable unfurling of media content.
Type: BOOLEAN
username
Set your bot's user name. Must be used in conjunction with as_user
set to false, otherwise ignored. See authorship below.
Type: STRING
post_message_as_ephemeral
Sends an ephemeral message to a user in a channel. See https://api.slack.com/methods/chat.postEphemeral for more information.
Parameters
as_user
Pass true to post the message as the authed bot. Defaults to false.
Type: BOOLEAN
attachments
A JSON-based array of structured attachments, presented as a URL-encoded string.
Type: STRING
blocks
A JSON-based array of structured blocks, presented as a URL-encoded string.
Type: STRING
channel
Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
Type: STRING
link_names
Find and link channel names and usernames.
Type: BOOLEAN
parse
Change how messages are treated. Defaults to none
. See below.
Type: STRING
text
Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments
instead.
Type: STRING
user
id
of the user who will receive the ephemeral message. The user should be in the channel specified by the channel
argument.
Type: STRING
post_message_as_me_action
Share a me message into a channel. See https://api.slack.com/methods/chat.meMessage for more information.
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.
Type: STRING
text
Text of the message to send.
Type: STRING
push_modal_view
Push a new view onto the existing view stack by passing a view payload and a valid trigger_id generated from an interaction within the existing modal. The pushed view is added to the top of the stack, so the user will go back to the previous view after they complete or cancel the pushed view. See https://api.slack.com/methods/views.push for more information.
Parameters
trigger_id
Exchange a trigger to post to the user.
Type: STRING
view
The view payload. This must be a JSON-encoded string.
Type: STRING
remove_pinned_message
Un-pins an item from a channel. See https://api.slack.com/methods/pins.remove for more information.
Parameters
channel
Channel where the item is pinned to.
Type: STRING
file
File to un-pin.
Type: STRING
file_comment
File comment to un-pin.
Type: STRING
timestamp
Timestamp of the message to un-pin.
Type: NUMBER
remove_reaction
Removes a reaction from an item. See https://api.slack.com/methods/reactions.remove for more information.
Parameters
channel
Channel where the message to remove reaction from was posted.
Type: STRING
file
File to remove reaction from.
Type: STRING
file_comment
File comment to remove reaction from.
Type: STRING
name
Reaction (emoji) name.
Type: STRING
timestamp
Timestamp of the message to remove reaction from.
Type: NUMBER
remove_star
Removes a star from an item. See https://api.slack.com/methods/stars.remove for more information.
Parameters
channel
Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp
).
Type: STRING
file
File to remove star from.
Type: STRING
file_comment
File comment to remove star from.
Type: STRING
timestamp
Timestamp of the message to remove star from.
Type: NUMBER
remove_user_from_conversation
Removes a user from a conversation. See https://api.slack.com/methods/conversations.kick for more information.
Parameters
channel
ID of conversation to remove user from.
Type: STRING
user
User ID to be removed.
Type: STRING
rename_conversation
Renames a conversation. See https://api.slack.com/methods/conversations.rename for more information.
Parameters
channel
ID of conversation to rename
Type: STRING
name
New name for conversation.
Type: STRING
request_permissions_for_app
Allows an app to request additional scopes. See https://api.slack.com/methods/apps.permissions.request for more information.
Parameters
scopes
A comma separated list of scopes to request for
Type: STRING
trigger_id
Token used to trigger the permissions API
Type: STRING
revoke_auth
Revokes a token. See https://api.slack.com/methods/auth.revoke for more information.
Parameters
test
Setting this parameter to 1
triggers a testing mode where the specified token will not actually be revoked.
Type: BOOLEAN
revoke_public_url_for_file
Revokes public/external sharing access for a file. See https://api.slack.com/methods/files.revokePublicURL for more information.
Parameters
file
File to revoke
Type: STRING
schedule_message
Sends a message to a channel. See https://api.slack.com/methods/chat.scheduleMessage for more information.
Parameters
as_user
Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
Type: BOOLEAN
attachments
A JSON-based array of structured attachments, presented as a URL-encoded string.
Type: STRING
blocks
A JSON-based array of structured blocks, presented as a URL-encoded string.
Type: STRING
channel
Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
Type: STRING
link_names
Find and link channel names and usernames.
Type: BOOLEAN
parse
Change how messages are treated. Defaults to none
. See below.
Type: STRING
post_at
Unix EPOCH timestamp of time in future to send the message.
Type: STRING
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
.
Type: BOOLEAN
text
Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments
instead. Provide no more than 40,000 characters or risk truncation.
Type: STRING
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.
Type: STRING
unfurl_links
Pass true to enable unfurling of primarily text-based content.
Type: BOOLEAN
unfurl_media
Pass false to disable unfurling of media content.
Type: BOOLEAN
search_all
Searches for messages and files matching a query. See https://api.slack.com/methods/search.all for more information.
Parameters
count
Type: STRING
highlight
Pass a value of true
to enable query highlight markers (see below).
Type: BOOLEAN
page
Type: STRING
query
Search query. May contains booleans, etc.
Type: STRING
sort
Return matches sorted by either score
or timestamp
.
Type: STRING
sort_dir
Change sort direction to ascending (asc
) or descending (desc
).
Type: STRING
search_files
Searches for files matching a query. See https://api.slack.com/methods/search.files for more information.
Parameters
highlight
Pass a value of true
to enable query highlight markers (see below).
Type: BOOLEAN
query
Search query.
Type: STRING
sort
Return matches sorted by either score
or timestamp
.
Type: STRING
sort_dir
Change sort direction to ascending (asc
) or descending (desc
).
Type: STRING
search_messages
Searches for messages matching a query. See https://api.slack.com/methods/search.messages for more information.
Parameters
highlight
Pass a value of true
to enable query highlight markers (see below).
Type: BOOLEAN
query
Search query.
Type: STRING
sort
Return matches sorted by either score
or timestamp
.
Type: STRING
sort_dir
Change sort direction to ascending (asc
) or descending (desc
).
Type: STRING
set_dnd_snooze_for_user
Turns on Do Not Disturb mode for the current user, or changes its duration. See https://api.slack.com/methods/dnd.setSnooze for more information.
Parameters
num_minutes
Number of minutes, from now, to snooze until.
Type: INTEGER
set_presence_for_user
Manually sets user presence. See https://api.slack.com/methods/users.setPresence for more information.
Parameters
presence
Either auto
or away
Type: STRING
set_profile_for_user
Set the profile information for a user. See https://api.slack.com/methods/users.profile.set for more information.
Parameters
name
Name of a single key to set. Usable only if profile
is not passed.
Type: STRING
profile
Collection of key:value pairs presented as a URL-encoded JSON hash.
Type: STRING
user
ID of user to change. This argument may only be specified by team admins on paid teams.
Type: STRING
value
Value to set a single key to. Usable only if profile
is not passed.
Type: STRING
set_purpose_of_conversation
Sets the purpose for a conversation. See https://api.slack.com/methods/conversations.setPurpose for more information.
Parameters
channel
Conversation to set the purpose of
Type: STRING
purpose
A new, specialer purpose
Type: STRING
set_topic_of_conversation
Sets the topic for a conversation. See https://api.slack.com/methods/conversations.setTopic for more information.
Parameters
channel
Conversation to set the topic of
Type: STRING
topic
The new topic string. Does not support formatting or linkification.
Type: STRING
set_unfurl_for_message
Provide custom unfurl behavior for user-posted URLs. See https://api.slack.com/methods/chat.unfurl for more information.
Parameters
channel
Channel ID of the message
Type: STRING
ts
Timestamp of the message to add unfurl behavior to.
Type: STRING
unfurls
URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl message attachments.
Type: STRING
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
Type: STRING
user_auth_required
Set to true
or 1
to indicate the user must install your Slack app to trigger unfurls for this domain
Type: BOOLEAN
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.
Type: STRING
start_rtm
Starts a Real Time Messaging session. See https://api.slack.com/methods/rtm.start for more information.
Parameters
batch_presence_aware
Batch presence deliveries via subscription. Enabling changes the shape of presence_change
events. See batch presence.
Type: BOOLEAN
include_locale
Set this to true
to receive the locale for users and channels. Defaults to false
Type: BOOLEAN
mpim_aware
Returns MPIMs to the client in the API response.
Type: BOOLEAN
no_latest
Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads
to 1
Type: BOOLEAN
no_unreads
Skip unread counts for each channel (improves performance).
Type: BOOLEAN
presence_sub
Only deliver presence events when requested by subscription. See presence subscriptions.
Type: BOOLEAN
simple_latest
Return timestamp only for latest message object of each channel (improves performance).
Type: BOOLEAN
test_api
Checks API calling code. See https://api.slack.com/methods/api.test for more information.
Parameters
error
Error response to return
Type: STRING
foo
example property to return
Type: STRING
test_auth
Checks authentication & identity. See https://api.slack.com/methods/auth.test for more information.
This operation has no parameters
unarchive_conversation
Reverses conversation archival. See https://api.slack.com/methods/conversations.unarchive for more information.
Parameters
channel
ID of conversation to unarchive
Type: STRING
update_message
Updates a message. See https://api.slack.com/methods/chat.update for more information.
Parameters
as_user
Pass true to update the message as the authed user. Bot users in this context are considered authed users.
Type: BOOLEAN
attachments
A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text
.
Type: STRING
blocks
A JSON-based array of structured blocks, presented as a URL-encoded string.
Type: STRING
channel
Channel containing the message to be updated.
Type: STRING
link_names
Find and link channel names and usernames. Defaults to none
. See below.
Type: BOOLEAN
parse
Change how messages are treated. Defaults to client
, unlike chat.postMessage
. See below.
Type: STRING
text
New text for the message, using the default formatting rules. It's not required when presenting attachments
.
Type: STRING
ts
Timestamp of the message to be updated.
Type: STRING
update_modal_view
Update a view by passing a new view definition along with the view_id
returned in views.open
or the external_id
. See https://api.slack.com/methods/views.update for more information.
Parameters
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.
Type: STRING
view
The view payload. This must be a JSON-encoded string.
Type: STRING
view_id
A unique identifier of the view to be updated.
Type: STRING
update_user_for_usergroup
Update the list of users for a User Group. See https://api.slack.com/methods/usergroups.users.update for more information.
Parameters
include_count
Include the number of users in the User Group.
Type: BOOLEAN
usergroup
The encoded ID of the User Group to update.
Type: STRING
users
A comma separated string of encoded user IDs that represent the entire list of users for the User Group.
Type: STRING
update_usergroup
Update an existing User Group. See https://api.slack.com/methods/usergroups.update for more information.
Parameters
channels
A comma separated string of encoded channel IDs for which the User Group uses as a default.
Type: STRING
description
A short description of the User Group.
Type: STRING
handle
A mention handle. Must be unique among channels, users and User Groups.
Type: STRING
include_count
Include the number of users in the User Group.
Type: BOOLEAN
name
A name for the User Group. Must be unique among User Groups.
Type: STRING
usergroup
The encoded ID of the User Group to update.
Type: STRING
upload_file
Uploads or creates a file. See https://api.slack.com/methods/files.upload for more information.
Parameters
channels
Comma-separated list of channel names or IDs where the file will be shared.
Type: STRING
content
File contents via a POST variable. If omitting this parameter, you must provide a file
.
Type: STRING
filename
Filename of file.
Type: STRING
filetype
A file type identifier.
Type: STRING
initial_comment
Initial comment to add to file.
Type: STRING
title
Title of file.
Type: STRING
token
Authentication token.
Type: STRING