Use wide Slack integration

With Ants & Apps platform you can connect Slack with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • admin.users.session.reset

    • Wipe all valid sessions on all devices for a given user

      This action wipes all valid sessions on all devices for a given user

      POSTAdminUsersSessionReset
  • api.test

    • Check API calling code

      This action checks API calling code.

      GETApiTest

      Request parameters

      • foostring

        example property to return

      • errorstring

        Error response to return

  • apps.permissions.info

    • Return list of permissions this app has on a team

      This action returns list of permissions this app has on a team.

      GETAppsPermissionsInfo
  • apps.permissions.request

    • Allow an app to request additional scopes

      This action allows an app to request additional scopes

      GETAppsPermissionsRequest

      Request parameters

      • scopesstring

        A comma separated list of scopes to request for

      • trigger_idstring

        Token used to trigger the permissions API

  • apps.permissions.resources.list

    • Return list of resource grants this app has on a team

      This action returns list of resource grants this app has on a team.

      GETAppsPermissionsResourcesList

      Request parameters

      • cursorstring

        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.

      • limitinteger

        The maximum number of items to return.

  • apps.permissions.scopes.list

    • Return list of scopes this app has on a team

      This action returns list of scopes this app has on a team.

      GETAppsPermissionsScopesList
  • apps.permissions.users.list

    • Return list of user grants and corresponding scopes this app has on a team

      This action returns list of user grants and corresponding scopes this app has on a team.

      GETAppsPermissionsUsersList

      Request parameters

      • cursorstring

        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.

      • limitinteger

        The maximum number of items to return.

  • apps.permissions.users.request

    • Enable an app to trigger a permissions modal to grant an app access to a user access scope

      This action enables an app to trigger a permissions modal to grant an app access to a user access scope.

      GETAppsPermissionsUsersRequest

      Request parameters

      • scopesstring

        A comma separated list of user scopes to request for

      • userstring

        The user this scope is being requested for

      • trigger_idstring

        Token used to trigger the request

  • apps.uninstall

    • Uninstall your app from a workspace

      This action uninstalls your app from a workspace.

      GETAppsUninstall

      Request parameters

      • client_secretstring

        Issued when you created your application.

      • client_idstring

        Issued when you created your application.

  • auth.revoke

    • Revoke a token

      This action revokes a token.

      GETAuthRevoke

      Request parameters

      • testboolean

        Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.

  • auth.test

    • Check authentication & identity

      This action checks authentication & identity.

      GETAuthTest
  • bots.info

    • Get information about a bot user

      This action gets information about a bot user.

      GETBotsInfo

      Request parameters

      • botstring

        Bot user to get info on

  • channels.archive

    • Archive a channel

      This action archives a channel.

      POSTChannelsArchive

      Request body

      • channelstring

        Channel to archive

  • channels.create

    • Create a channel

      This action creates a channel.

      POSTChannelsCreate

      Request body

      • namestring

        Name of channel to create

      • validateboolean

        Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • channels.history

    • Fetch history of messages and events from a channel

      This action fetches history of messages and events from a channel.

      GETChannelsHistory

      Request parameters

      • countinteger

        Number of messages to return, between 1 and 1000.

      • unreadsboolean

        Include `unread_count_display` in the output?

      • inclusiveboolean

        Include messages with latest or oldest timestamp in results.

      • oldestnumber

        Start of time range of messages to include in results.

      • channelstring

        Channel to fetch history for.

      • latestnumber

        End of time range of messages to include in results.

  • channels.info

    • Get information about a channel

      This action gets information about a channel.

      GETChannelsInfo

      Request parameters

      • include_localeboolean

        Set this to `true` to receive the locale for this channel. Defaults to `false`

      • channelstring

        Channel to get info on

  • channels.invite

    • Invite a user to a channel

      This action invites a user to a channel.

      POSTChannelsInvite

      Request body

      • channelstring

        Channel to invite user to.

      • userstring

        User to invite to channel.

  • channels.join

    • Join a channel, creating it if needed

      This action joins a channel, creating it if needed.

      POSTChannelsJoin

      Request body

      • namestring

        Name of channel to join

      • validateboolean

        Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • channels.kick

    • Remove a user from a channel

      This action removes a user from a channel.

      POSTChannelsKick

      Request body

      • channelstring

        Channel to remove user from.

      • userstring

        User to remove from channel.

  • channels.leave

    • Leave a channel

      This action leaves a channel.

      POSTChannelsLeave

      Request body

      • channelstring

        Channel to leave

  • channels.list

    • List all channels in a Slack team

      This action lists all channels in a Slack team.

      GETChannelsList

      Request parameters

      • exclude_membersboolean

        Exclude the `members` collection from each `channel`

      • cursorstring

        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.

      • limitinteger

        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.

      • exclude_archivedboolean

        Exclude archived channels from the list

  • channels.mark

    • Set the read cursor in a channel

      This action sets the read cursor in a channel.

      POSTChannelsMark

      Request body

      • channelstring

        Channel to set reading cursor in.

      • tsnumber

        Timestamp of the most recently seen message.

  • channels.rename

    • Rename a channel

      This action renames a channel.

      POSTChannelsRename

      Request body

      • channelstring

        Channel to rename

      • namestring

        New name for channel.

      • validateboolean

        Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • channels.replies

    • Retrieve a thread of messages posted to a channel

      This action retrieve a thread of messages posted to a channel

      GETChannelsReplies

      Request parameters

      • thread_tsnumber

        Unique identifier of a thread's parent message

      • channelstring

        Channel to fetch thread from

  • channels.setPurpose

    • Set the purpose for a channel

      This action sets the purpose for a channel.

      POSTChannelsSetPurpose

      Request body

      • channelstring

        Channel to set the purpose of

      • purposestring

        The new purpose

  • channels.setTopic

    • Set the topic for a channel

      This action sets the topic for a channel.

      POSTChannelsSetTopic

      Request body

      • channelstring

        Channel to set the topic of

      • topicstring

        The new topic

  • channels.unarchive

    • Unarchive a channel

      This action unarchives a channel.

      POSTChannelsUnarchive

      Request body

      • channelstring

        Channel to unarchive

  • chat.delete

    • Delete a message

      This action deletes a message.

      POSTChatDelete

      Request body

      • as_userboolean

        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.

      • channelstring

        Channel containing the message to be deleted.

      • tsnumber

        Timestamp of the message to be deleted.

  • chat.deleteScheduledMessage

    • Delete a pending scheduled message from the queue

      This action deletes a pending scheduled message from the queue.

      POSTChatDeleteScheduledMessage
  • chat.getPermalink

    • Retrieve a permalink URL for a specific extant message

      This action retrieve a permalink URL for a specific extant message

      GETChatGetPermalink

      Request parameters

      • message_tsnumber

        A message's `ts` value, uniquely identifying it within a channel

      • channelstring

        The ID of the conversation or channel containing the message

  • chat.meMessage

    • Share a me message into a channel

      This action share a me message into a channel.

      POSTChatMeMessage

      Request body

      • channelstring

        Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.

      • textstring

        Text of the message to send.

  • chat.postEphemeral

    • Send an ephemeral message to a user in a channel

      This action sends an ephemeral message to a user in a channel.

      POSTChatPostEphemeral

      Request body

      • as_userboolean

        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.

      • attachmentsstring

        A JSON-based array of structured attachments, presented as a URL-encoded string.

      • blocksstring

        A JSON-based array of structured blocks, presented as a URL-encoded string.

      • channelstring

        Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

      • link_namesboolean

        Find and link channel names and usernames.

      • parsestring

        Change how messages are treated. Defaults to `none`. See [below](#formatting).

      • textstring

        Text of the message to send. See below for an explanation of [formatting](#formatting). This field is usually required, unless you're providing only `attachments` instead.

      • thread_tsnumber

        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.

      • userstring

        `id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.

  • chat.postMessage

    • Send a message to a channel

      This action sends a message to a channel.

      POSTChatPostMessage

      Request body

      • as_userboolean

        Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.

      • attachmentsstring

        A JSON-based array of structured attachments, presented as a URL-encoded string.

      • blocksstring

        A JSON-based array of structured blocks, presented as a URL-encoded string.

      • channelstring

        Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.

      • icon_emojistring

        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.

      • icon_urlstring

        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.

      • link_namesboolean

        Find and link channel names and usernames.

      • mrkdwnboolean

        Disable Slack markup parsing by setting to `false`. Enabled by default.

      • parsestring

        Change how messages are treated. Defaults to `none`. See [below](#formatting).

      • reply_broadcastboolean

        Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.

      • textstring

        Text of the message to send. See below for an explanation of [formatting](#formatting). This field is usually required, unless you're providing only `attachments` instead. Provide no more than 40,000 characters or [risk truncation](/changelog/2018-04-truncating-really-long-messages).

      • thread_tsnumber

        Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.

      • unfurl_linksboolean

        Pass true to enable unfurling of primarily text-based content.

      • unfurl_mediaboolean

        Pass false to disable unfurling of media content.

      • usernamestring

        Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.

  • chat.scheduledMessages.list

    • Return a list of scheduled messages

      This action returns a list of scheduled messages.

      GETChatScheduledMessagesList

      Request parameters

      • cursorstring

        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.

      • limitinteger

        Maximum number of original entries to return.

      • oldestnumber

        A UNIX timestamp of the oldest value in the time range

      • channelstring

        The channel of the scheduled messages

      • latestnumber

        A UNIX timestamp of the latest value in the time range

  • chat.scheduleMessage

    • Schedule a message to be sent to a channel

      This action schedules a message to be sent to a channel.

      POSTChatScheduleMessage

      Request body

      • as_userboolean

        Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.

      • attachmentsstring

        A JSON-based array of structured attachments, presented as a URL-encoded string.

      • blocksstring

        A JSON-based array of structured blocks, presented as a URL-encoded string.

      • channelstring

        Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.

      • link_namesboolean

        Find and link channel names and usernames.

      • parsestring

        Change how messages are treated. Defaults to `none`. See [below](#formatting).

      • post_atstring

        Unix EPOCH timestamp of time in future to send the message.

      • reply_broadcastboolean

        Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.

      • textstring

        Text of the message to send. See below for an explanation of [formatting](#formatting). This field is usually required, unless you're providing only `attachments` instead. Provide no more than 40,000 characters or [risk truncation](/changelog/2018-04-truncating-really-long-messages).

      • thread_tsnumber

        Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.

      • unfurl_linksboolean

        Pass true to enable unfurling of primarily text-based content.

      • unfurl_mediaboolean

        Pass false to disable unfurling of media content.

  • chat.unfurl

    • Provide custom unfurl behavior for user-posted URLs

      This action provide custom unfurl behavior for user-posted URLs

      POSTChatUnfurl

      Request body

      • channelstring

        Channel ID of the message

      • tsstring

        Timestamp of the message to add unfurl behavior to.

      • unfurlsstring

        URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.

      • user_auth_messagestring

        Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

      • user_auth_requiredboolean

        Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain

      • user_auth_urlstring

        Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

  • chat.update

    • Update a message

      This action updates a message.

      POSTChatUpdate

      Request body

      • as_userboolean

        Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users.

      • attachmentsstring

        A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`.

      • blocksstring

        A JSON-based array of structured blocks, presented as a URL-encoded string.

      • channelstring

        Channel containing the message to be updated.

      • link_namesboolean

        Find and link channel names and usernames. Defaults to `none`. See [below](#formatting).

      • parsestring

        Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. See [below](#formatting).

      • textstring

        New text for the message, using the [default formatting rules](/docs/formatting). It's not required when presenting `attachments`.

      • tsnumber

        Timestamp of the message to be updated.

  • conversations.archive

    • Archive a conversation

      This action archives a conversation.

      POSTConversationsArchive

      Request body

      • channelstring

        ID of conversation to archive

  • conversations.close

    • Close a direct message or multi-person direct message

      This action closes a direct message or multi-person direct message.

      POSTConversationsClose

      Request body

      • channelstring

        Conversation to close.

  • conversations.create

    • Initiate a public or private channel-based conversation

      This action initiates a public or private channel-based conversation

      POSTConversationsCreate

      Request body

      • is_privateboolean

        Create a private channel instead of a public one

      • namestring

        Name of the public or private channel to create

      • user_idsstring

        **Required** for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.

  • conversations.history

    • Fetch a conversation's history of messages and events

      This action fetches a conversation's history of messages and events.

      GETConversationsHistory

      Request parameters

      • inclusiveboolean

        Include messages with latest or oldest timestamp in results only when either timestamp is specified.

      • cursorstring

        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.

      • limitinteger

        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.

      • oldestnumber

        Start of time range of messages to include in results.

      • channelstring

        Conversation ID to fetch history for.

      • latestnumber

        End of time range of messages to include in results.

  • conversations.info

    • Retrieve information about a conversation

      This action retrieve information about a conversation.

      GETConversationsInfo

      Request parameters

      • include_num_membersboolean

        Set to `true` to include the member count for the specified conversation. Defaults to `false`

      • channelstring

        Conversation ID to learn more about

      • include_localeboolean

        Set this to `true` to receive the locale for this conversation. Defaults to `false`

  • conversations.invite

    • Invite users to a channel

      This action invites users to a channel.

      POSTConversationsInvite

      Request body

      • channelstring

        The ID of the public or private channel to invite user(s) to.

      • usersstring

        A comma separated list of user IDs. Up to 30 users may be listed.

  • conversations.join

    • Join an existing conversation

      This action joins an existing conversation.

      POSTConversationsJoin

      Request body

      • channelstring

        ID of conversation to join

  • conversations.kick

    • Remove a user from a conversation

      This action removes a user from a conversation.

      POSTConversationsKick

      Request body

      • channelstring

        ID of conversation to remove user from.

      • userstring

        User ID to be removed.

  • conversations.leave

    • Leave a conversation

      This action leaves a conversation.

      POSTConversationsLeave

      Request body

      • channelstring

        Conversation to leave

  • conversations.list

    • List all channels in a Slack team

      This action lists all channels in a Slack team.

      GETConversationsList

      Request parameters

      • cursorstring

        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.

      • limitinteger

        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.

      • exclude_archivedboolean

        Set to `true` to exclude archived channels from the list

      • typesstring

        Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`

  • conversations.members

    • Retrieve members of a conversation

      This action retrieve members of a conversation.

      GETConversationsMembers

      Request parameters

      • cursorstring

        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.

      • limitinteger

        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.

      • channelstring

        ID of the conversation to retrieve members for

  • conversations.open

    • Open or resumes a direct message or multi-person direct message

      This action opens or resumes a direct message or multi-person direct message.

      POSTConversationsOpen

      Request body

      • channelstring

        Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.

      • return_imboolean

        Boolean, indicates you want the full IM channel definition in the response.

      • usersstring

        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`.

  • conversations.rename

    • Rename a conversation

      This action renames a conversation.

      POSTConversationsRename

      Request body

      • channelstring

        ID of conversation to rename

      • namestring

        New name for conversation.

  • conversations.replies

    • Retrieve a thread of messages posted to a conversation

      This action retrieve a thread of messages posted to a conversation

      GETConversationsReplies

      Request parameters

      • inclusiveboolean

        Include messages with latest or oldest timestamp in results only when either timestamp is specified.

      • tsnumber

        Unique identifier of a thread's parent message.

      • cursorstring

        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.

      • limitinteger

        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.

      • oldestnumber

        Start of time range of messages to include in results.

      • channelstring

        Conversation ID to fetch thread from.

      • latestnumber

        End of time range of messages to include in results.

  • conversations.setPurpose

    • Set the purpose for a conversation

      This action sets the purpose for a conversation.

      POSTConversationsSetPurpose

      Request body

      • channelstring

        Conversation to set the purpose of

      • purposestring

        A new, specialer purpose

  • conversations.setTopic

    • Set the topic for a conversation

      This action sets the topic for a conversation.

      POSTConversationsSetTopic

      Request body

      • channelstring

        Conversation to set the topic of

      • topicstring

        The new topic string. Does not support formatting or linkification.

  • conversations.unarchive

    • Reverse conversation archival

      This action reverses conversation archival.

      POSTConversationsUnarchive

      Request body

      • channelstring

        ID of conversation to unarchive

  • dialog.open

    • Open a dialog with a user

      This action open a dialog with a user

      GETDialogOpen
  • dnd.endDnd

    • End the current user's Do Not Disturb session immediately

      This action ends the current user's Do Not Disturb session immediately.

      POSTDndEndDnd
  • dnd.endSnooze

    • End the current user's snooze mode immediately

      This action ends the current user's snooze mode immediately.

      POSTDndEndSnooze
  • dnd.info

    • Retrief a user's current Do Not Disturb status

      This action retrieves a user's current Do Not Disturb status.

      GETDndInfo

      Request parameters

      • userstring

        User to fetch status for (defaults to current user)

  • dnd.setSnooze

    • Turn on Do Not Disturb mode for the current user, or changes its duration

      This action turns on Do Not Disturb mode for the current user, or changes its duration.

      POSTDndSetSnooze
  • dnd.teamInfo

    • Retrief the Do Not Disturb status for up to 50 users on a team

      This action retrieves the Do Not Disturb status for up to 50 users on a team.

      GETDndTeamInfo

      Request parameters

      • usersstring

        Comma-separated list of users to fetch Do Not Disturb status for

  • emoji.list

    • List custom emoji for a team

      This action lists custom emoji for a team.

      GETEmojiList
  • files.comments.delete

    • Delete an existing comment on a file

      This action deletes an existing comment on a file.

      POSTFilesCommentsDelete

      Request body

      • filestring

        File to delete a comment from.

      • idstring

        The comment to delete.

  • files.delete

    • Delete a file

      This action deletes a file.

      POSTFilesDelete

      Request body

      • filestring

        ID of file to delete.

  • files.info

    • Get information about a team file

      This action gets information about a team file.

      GETFilesInfo

      Request parameters

      • countstring

      • cursorstring

        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.

      • limitinteger

        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.

      • filestring

        Specify a file by providing its ID.

      • pagestring

  • files.list

    • List & filters team files

      This action lists & filters team files.

      GETFilesList

      Request parameters

      • countstring

      • channelstring

        Filter files appearing in a specific channel, indicated by its ID.

      • ts_tonumber

        Filter files created before this timestamp (inclusive).

      • ts_fromnumber

        Filter files created after this timestamp (inclusive).

      • userstring

        Filter files created by a single user.

      • pagestring

      • typesstring

        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.

  • files.revokePublicURL

    • Revoke public/external sharing access for a file

      This action revokes public/external sharing access for a file

      POSTFilesRevokePublicURL

      Request body

      • filestring

        File to revoke

  • files.sharedPublicURL

    • Enable a file for public/external sharing

      This action enables a file for public/external sharing.

      POSTFilesSharedPublicURL

      Request body

      • filestring

        File to share

  • files.upload

    • Upload or creates a file

      This action uploads or creates a file.

      POSTFilesUpload

      Request body

      • channelsstring

        Comma-separated list of channel names or IDs where the file will be shared.

      • contentstring

        File contents via a POST variable. If omitting this parameter, you must provide a `file`.

      • filestring

        File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`.

      • filenamestring

        Filename of file.

      • filetypestring

        A [file type](/types/file#file_types) identifier.

      • initial_commentstring

        The message text introducing the file in specified `channels`.

      • thread_tsnumber

        Provide another message's `ts` value to upload this file as a reply. Never use a reply's `ts` value; use its parent instead.

      • titlestring

        Title of file.

      • tokenstring

        Authentication token. Requires scope: `files:write:user`

  • groups.archive

    • Archive a private channel

      This action archives a private channel.

      POSTGroupsArchive

      Request body

      • channelstring

        Private channel to archive

  • groups.create

    • Create a private channel

      This action creates a private channel.

      POSTGroupsCreate

      Request body

      • namestring

        Name of private channel to create

      • validateboolean

        Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • groups.createChild

    • Clone and archives a private channel

      This action clones and archives a private channel.

      POSTGroupsCreateChild

      Request body

      • channelstring

        Private channel to clone and archive.

      • tokenstring

        Authentication token. Requires scope: `groups:write`

  • groups.history

    • Fetch history of messages and events from a private channel

      This action fetches history of messages and events from a private channel.

      GETGroupsHistory

      Request parameters

      • countinteger

        Number of messages to return, between 1 and 1000.

      • unreadsboolean

        Include `unread_count_display` in the output?

      • inclusiveboolean

        Include messages with latest or oldest timestamp in results.

      • oldestnumber

        Start of time range of messages to include in results.

      • channelstring

        Private channel to fetch history for.

      • latestnumber

        End of time range of messages to include in results.

  • groups.info

    • Get information about a private channel

      This action gets information about a private channel.

      GETGroupsInfo

      Request parameters

      • include_localeboolean

        Set this to `true` to receive the locale for this group. Defaults to `false`

      • channelstring

        Private channel to get info on

  • groups.invite

    • Invite a user to a private channel

      This action invites a user to a private channel.

      POSTGroupsInvite

      Request body

      • channelstring

        Private channel to invite user to.

      • userstring

        User to invite.

  • groups.kick

    • Remove a user from a private channel

      This action removes a user from a private channel.

      POSTGroupsKick

      Request body

      • channelstring

        Private channel to remove user from.

      • userstring

        User to remove from private channel.

  • groups.leave

    • Leave a private channel

      This action leaves a private channel.

      POSTGroupsLeave

      Request body

      • channelstring

        Private channel to leave

  • groups.list

    • List private channels that the calling user has access to

      This action lists private channels that the calling user has access to.

      GETGroupsList

      Request parameters

      • cursorstring

        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.

      • exclude_membersboolean

        Exclude the `members` from each `group`

      • exclude_archivedboolean

        Don't return archived private channels.

      • limitinteger

        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.

  • groups.mark

    • Set the read cursor in a private channel

      This action sets the read cursor in a private channel.

      POSTGroupsMark

      Request body

      • channelstring

        Private channel to set reading cursor in.

      • tsnumber

        Timestamp of the most recently seen message.

  • groups.open

    • Open a private channel

      This action opens a private channel.

      POSTGroupsOpen

      Request body

      • channelstring

        Private channel to open.

  • groups.rename

    • Rename a private channel

      This action renames a private channel.

      POSTGroupsRename

      Request body

      • channelstring

        Private channel to rename

      • namestring

        New name for private channel.

      • validateboolean

        Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • groups.replies

    • Retrieve a thread of messages posted to a private channel

      This action retrieve a thread of messages posted to a private channel

      GETGroupsReplies

      Request parameters

      • thread_tsnumber

        Unique identifier of a thread's parent message

      • channelstring

        Private channel to fetch thread from

  • groups.setPurpose

    • Set the purpose for a private channel

      This action sets the purpose for a private channel.

      POSTGroupsSetPurpose

      Request body

      • channelstring

        Private channel to set the purpose of

      • purposestring

        The new purpose

  • groups.setTopic

    • Set the topic for a private channel

      This action sets the topic for a private channel.

      POSTGroupsSetTopic

      Request body

      • channelstring

        Private channel to set the topic of

      • topicstring

        The new topic

  • groups.unarchive

    • Unarchive a private channel

      This action unarchives a private channel.

      POSTGroupsUnarchive

      Request body

      • channelstring

        Private channel to unarchive

  • im.close

    • Close a direct message channel

      This action close a direct message channel.

      POSTImClose
  • im.history

    • Fetch history of messages and events from direct message channel

      This action fetches history of messages and events from direct message channel.

      GETImHistory

      Request parameters

      • countinteger

        Number of messages to return, between 1 and 1000.

      • unreadsboolean

        Include `unread_count_display` in the output?

      • inclusiveboolean

        Include messages with latest or oldest timestamp in results.

      • oldestnumber

        Start of time range of messages to include in results.

      • channelstring

        Direct message channel to fetch history for.

      • latestnumber

        End of time range of messages to include in results.

  • im.list

    • List direct message channels for the calling user

      This action lists direct message channels for the calling user.

      GETImList

      Request parameters

      • cursorstring

        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.

      • limitinteger

        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.

  • im.mark

    • Set the read cursor in a direct message channel

      This action sets the read cursor in a direct message channel.

      POSTImMark

      Request body

      • channelstring

        Direct message channel to set reading cursor in.

      • tsnumber

        Timestamp of the most recently seen message.

  • im.open

    • Open a direct message channel

      This action opens a direct message channel.

      POSTImOpen

      Request body

      • include_localeboolean

        Set this to `true` to receive the locale for this im. Defaults to `false`

      • return_imboolean

        Boolean, indicates you want the full IM channel definition in the response.

      • userstring

        User to open a direct message channel with.

  • im.replies

    • Retrieve a thread of messages posted to a direct message conversation

      This action retrieve a thread of messages posted to a direct message conversation

      GETImReplies

      Request parameters

      • thread_tsnumber

        Unique identifier of a thread's parent message

      • channelstring

        Direct message channel to fetch thread from

  • migration.exchange

    • For Enterprise Grid workspaces, map local user IDs to global user IDs

      This action for Enterprise Grid workspaces, map local user IDs to global user IDs

      GETMigrationExchange
  • mpim.close

    • Close a multiparty direct message channel

      This action closes a multiparty direct message channel.

      POSTMpimClose

      Request body

      • channelstring

        MPIM to close.

  • mpim.history

    • Fetch history of messages and events from a multiparty direct message

      This action fetches history of messages and events from a multiparty direct message.

      GETMpimHistory

      Request parameters

      • countinteger

        Number of messages to return, between 1 and 1000.

      • unreadsboolean

        Include `unread_count_display` in the output?

      • inclusiveboolean

        Include messages with latest or oldest timestamp in results.

      • oldestnumber

        Start of time range of messages to include in results.

      • channelstring

        Multiparty direct message to fetch history for.

      • latestnumber

        End of time range of messages to include in results.

  • mpim.list

    • List multiparty direct message channels for the calling user

      This action lists multiparty direct message channels for the calling user.

      GETMpimList

      Request parameters

      • cursorstring

        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.

      • limitinteger

        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.

  • mpim.mark

    • Set the read cursor in a multiparty direct message channel

      This action sets the read cursor in a multiparty direct message channel.

      POSTMpimMark

      Request body

      • channelstring

        multiparty direct message channel to set reading cursor in.

      • tsnumber

        Timestamp of the most recently seen message.

  • mpim.open

    • This method opens a multiparty direct message

      This action this method opens a multiparty direct message.

      POSTMpimOpen

      Request body

      • usersstring

        Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.

  • mpim.replies

    • Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message

      This action retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.

      GETMpimReplies

      Request parameters

      • thread_tsnumber

        Unique identifier of a thread's parent message.

      • channelstring

        Multiparty direct message channel to fetch thread from.

  • oauth.access

    • Exchange a temporary OAuth verifier code for an access token

      This action exchanges a temporary OAuth verifier code for an access token.

      GETOauthAccess

      Request parameters

      • codestring

        The `code` param returned via the OAuth callback.

      • redirect_uristring

        This must match the originally submitted URI (if one was sent).

      • client_idstring

        Issued when you created your application.

      • client_secretstring

        Issued when you created your application.

      • single_channelboolean

        Request the user to add your app only to a single channel.

  • oauth.token

    • Exchange a temporary OAuth verifier code for a workspace token

      This action exchanges a temporary OAuth verifier code for a workspace token.

      GETOauthToken

      Request parameters

      • client_secretstring

        Issued when you created your application.

      • codestring

        The `code` param returned via the OAuth callback.

      • single_channelboolean

        Request the user to add your app only to a single channel.

      • client_idstring

        Issued when you created your application.

      • redirect_uristring

        This must match the originally submitted URI (if one was sent).

  • pins.add

    • Pin an item to a channel

      This action pins an item to a channel.

      POSTPinsAdd

      Request body

      • channelstring

        Channel to pin the item in.

      • filestring

        File to pin.

      • file_commentstring

        File comment to pin.

      • timestampnumber

        Timestamp of the message to pin.

  • pins.list

    • List items pinned to a channel

      This action lists items pinned to a channel.

      GETPinsList

      Request parameters

      • channelstring

        Channel to get pinned items for.

  • pins.remove

    • Un-pin an item from a channel

      This action un-pins an item from a channel.

      POSTPinsRemove

      Request body

      • channelstring

        Channel where the item is pinned to.

      • filestring

        File to un-pin.

      • file_commentstring

        File comment to un-pin.

      • timestampnumber

        Timestamp of the message to un-pin.

  • reactions.add

    • Add a reaction to an item

      This action adds a reaction to an item.

      POSTReactionsAdd

      Request body

      • channelstring

        Channel where the message to add reaction to was posted.

      • filestring

        File to add reaction to. Now that [file threads](/changelog/2018-05-file-threads-soon-tread#whats_changed) work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead.

      • file_commentstring

        File comment to add reaction to. Now that [file threads](/changelog/2018-05-file-threads-soon-tread#whats_changed) work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead.

      • namestring

        Reaction (emoji) name.

      • timestampnumber

        Timestamp of the message to add reaction to.

  • reactions.get

    • Get reactions for an item

      This action gets reactions for an item.

      GETReactionsGet

      Request parameters

      • fullboolean

        If true always return the complete reaction list.

      • file_commentstring

        File comment to get reactions for.

      • timestampnumber

        Timestamp of the message to get reactions for.

      • filestring

        File to get reactions for.

      • channelstring

        Channel where the message to get reactions for was posted.

  • reactions.list

    • List reactions made by a user

      This action lists reactions made by a user.

      GETReactionsList

      Request parameters

      • countstring

      • fullboolean

        If true always return the complete reaction list.

      • cursorstring

        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.

      • limitinteger

        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.

      • userstring

        Show reactions made by this user. Defaults to the authed user.

      • pagestring

  • reactions.remove

    • Remove a reaction from an item

      This action removes a reaction from an item.

      POSTReactionsRemove

      Request body

      • channelstring

        Channel where the message to remove reaction from was posted.

      • filestring

        File to remove reaction from.

      • file_commentstring

        File comment to remove reaction from.

      • namestring

        Reaction (emoji) name.

      • timestampnumber

        Timestamp of the message to remove reaction from.

  • reminders.add

    • Create a reminder

      This action creates a reminder.

      POSTRemindersAdd

      Request body

      • textstring

        The content of the reminder

      • timestring

        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")

      • userstring

        The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.

  • reminders.complete

    • Mark a reminder as complete

      This action marks a reminder as complete.

      POSTRemindersComplete

      Request body

      • reminderstring

        The ID of the reminder to be marked as complete

  • reminders.delete

    • Delete a reminder

      This action deletes a reminder.

      POSTRemindersDelete

      Request body

      • reminderstring

        The ID of the reminder

  • reminders.info

    • Get information about a reminder

      This action gets information about a reminder.

      GETRemindersInfo

      Request parameters

      • reminderstring

        The ID of the reminder

  • reminders.list

    • List all reminders created by or for a given user

      This action lists all reminders created by or for a given user.

      GETRemindersList
  • rtm.connect

    • Start a Real Time Messaging session

      This action starts a Real Time Messaging session.

      GETRtmConnect

      Request parameters

      • presence_subboolean

        Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).

      • batch_presence_awareboolean

        Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).

  • search.messages

    • Search for messages matching a query

      This action searches for messages matching a query.

      GETSearchMessages

      Request parameters

      • sort_dirstring

        Change sort direction to ascending (`asc`) or descending (`desc`).

      • querystring

        Search query.

      • sortstring

        Return matches sorted by either `score` or `timestamp`.

      • countstring

        Pass the number of results you want per "page". Maximum of `100`.

      • highlightboolean

        Pass a value of `true` to enable query highlight markers (see below).

      • pagestring

  • stars.add

    • Add a star to an item

      This action adds a star to an item.

      POSTStarsAdd

      Request body

      • channelstring

        Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`).

      • filestring

        File to add star to.

      • file_commentstring

        File comment to add star to.

      • timestampnumber

        Timestamp of the message to add star to.

  • stars.list

    • List stars for a user

      This action lists stars for a user.

      GETStarsList

      Request parameters

      • countstring

      • cursorstring

        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.

      • limitinteger

        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.

      • pagestring

  • stars.remove

    • Remove a star from an item

      This action removes a star from an item.

      POSTStarsRemove

      Request body

      • channelstring

        Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`).

      • filestring

        File to remove star from.

      • file_commentstring

        File comment to remove star from.

      • timestampnumber

        Timestamp of the message to remove star from.

  • team.accessLogs

    • Get the access logs for the current team

      This action gets the access logs for the current team.

      GETTeamAccessLogs

      Request parameters

      • countstring

      • pagestring

      • beforeinteger

        End of time range of logs to include in results (inclusive).

  • team.billableInfo

    • Get billable users information for the current team

      This action gets billable users information for the current team.

      GETTeamBillableInfo
  • team.info

    • Get information about the current team

      This action gets information about the current team.

      GETTeamInfo

      Request parameters

      • teamstring

        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

  • team.integrationLogs

    • Get the integration logs for the current team

      This action gets the integration logs for the current team.

      GETTeamIntegrationLogs

      Request parameters

      • countstring

      • change_typestring

        Filter logs with this change type. Defaults to all logs.

      • app_idinteger

        Filter logs to this Slack app. Defaults to all logs.

      • userstring

        Filter logs generated by this user’s actions. Defaults to all logs.

      • service_idinteger

        Filter logs to this service. Defaults to all logs.

      • pagestring

  • team.profile.get

    • Retrieve a team's profile

      This action retrieve a team's profile.

      GETTeamProfileGet

      Request parameters

      • visibilitystring

        Filter by visibility.

  • usergroups.create

    • Create a User Group

      This action create a User Group

      POSTUsergroupsCreate

      Request body

      • channelsstring

        A comma separated string of encoded channel IDs for which the User Group uses as a default.

      • descriptionstring

        A short description of the User Group.

      • handlestring

        A mention handle. Must be unique among channels, users and User Groups.

      • include_countboolean

        Include the number of users in each User Group.

      • namestring

        A name for the User Group. Must be unique among User Groups.

  • usergroups.disable

    • Disable an existing User Group

      This action disable an existing User Group

      POSTUsergroupsDisable

      Request body

      • include_countboolean

        Include the number of users in the User Group.

      • usergroupstring

        The encoded ID of the User Group to disable.

  • usergroups.enable

    • Enable a User Group

      This action enable a User Group

      POSTUsergroupsEnable

      Request body

      • include_countboolean

        Include the number of users in the User Group.

      • usergroupstring

        The encoded ID of the User Group to enable.

  • usergroups.list

    • List all User Groups for a team

      This action list all User Groups for a team

      GETUsergroupsList

      Request parameters

      • include_usersboolean

        Include the list of users for each User Group.

      • include_countboolean

        Include the number of users in each User Group.

      • include_disabledboolean

        Include disabled User Groups.

  • usergroups.update

    • Update an existing User Group

      This action update an existing User Group

      POSTUsergroupsUpdate

      Request body

      • channelsstring

        A comma separated string of encoded channel IDs for which the User Group uses as a default.

      • descriptionstring

        A short description of the User Group.

      • handlestring

        A mention handle. Must be unique among channels, users and User Groups.

      • include_countboolean

        Include the number of users in the User Group.

      • namestring

        A name for the User Group. Must be unique among User Groups.

      • usergroupstring

        The encoded ID of the User Group to update.

  • usergroups.users.list

    • List all users in a User Group

      This action list all users in a User Group

      GETUsergroupsUsersList
  • usergroups.users.update

    • Update the list of users for a User Group

      This action update the list of users for a User Group

      POSTUsergroupsUsersUpdate

      Request body

      • include_countboolean

        Include the number of users in the User Group.

      • usergroupstring

        The encoded ID of the User Group to update.

      • usersstring

        A comma separated string of encoded user IDs that represent the entire list of users for the User Group.

  • users.conversations

    • List conversations the calling user may access

      This action list conversations the calling user may access.

      GETUsersConversations

      Request parameters

      • cursorstring

        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.

      • limitinteger

        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.

      • userstring

        Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.

      • exclude_archivedboolean

        Set to `true` to exclude archived channels from the list

      • typesstring

        Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`

  • users.deletePhoto

    • Delete the user profile photo

      This action delete the user profile photo

      POSTUsersDeletePhoto

      Request body

      • tokenstring

        Authentication token. Requires scope: `users.profile:write`

  • users.getPresence

    • Get user presence information

      This action gets user presence information.

      GETUsersGetPresence

      Request parameters

      • userstring

        User to get presence info on. Defaults to the authed user.

  • users.identity

  • users.info

    • Get information about a user

      This action gets information about a user.

      GETUsersInfo

      Request parameters

      • userstring

        User to get info on

      • include_localeboolean

        Set this to `true` to receive the locale for this user. Defaults to `false`

  • users.list

    • List all users in a Slack team

      This action lists all users in a Slack team.

      GETUsersList

      Request parameters

      • cursorstring

        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.

      • limitinteger

        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.

      • include_localeboolean

        Set this to `true` to receive the locale for users. Defaults to `false`

  • users.lookupByEmail

    • Find a user with an email address

      This action find a user with an email address.

      GETUsersLookupByEmail

      Request parameters

      • emailstring

        An email address belonging to a user in the workspace

  • users.profile.get

    • Retrief a user's profile information

      This action retrieves a user's profile information.

      GETUsersProfileGet

      Request parameters

      • include_labelsboolean

        Include labels for each ID in custom profile fields

      • userstring

        User to retrieve profile info for

  • users.profile.set

    • Set the profile information for a user

      This action set the profile information for a user.

      POSTUsersProfileSet

      Request body

      • namestring

        Name of a single key to set. Usable only if `profile` is not passed.

      • profilestring

        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.

      • userstring

        ID of user to change. This argument may only be specified by team admins on paid teams.

      • valuestring

        Value to set a single key to. Usable only if `profile` is not passed.

  • users.setActive

    • Marked a user as active

      This action marked a user as active. Deprecated and non-functional.

      POSTUsersSetActive
  • users.setPhoto

    • Set the user profile photo

      This action set the user profile photo

      POSTUsersSetPhoto

      Request body

      • crop_winteger

        Width/height of crop box (always square)

      • crop_xinteger

        X coordinate of top-left corner of crop box

      • crop_yinteger

        Y coordinate of top-left corner of crop box

      • imagestring

        File contents via `multipart/form-data`.

      • tokenstring

        Authentication token. Requires scope: `users.profile:write`

  • users.setPresence

    • Manually sets user presence

      This action manually sets user presence.

      POSTUsersSetPresence

      Request body

      • presencestring

        Either `auto` or `away`