Slack Web API

Slack Web API

Demo
DEMO PURPOSES ONLY

This is not official version of Slack API Documentation.
Link to Official documentation

Operations
Chat Operations
POST /chat.postMessage
POST /chat.meMessage
GET /chat.getPermalink
POST /chat.delete
POST /chat.unfurl
POST /chat.postEphemeral
POST /chat.update
chat_postMessage
POST /chat.postMessage

Authentication

slackAuth
chat:write:user
chat:write:bot

Sends a message to a channel.

Request headers

token
string optional

Authentication token. Requires scope: chat:write

Request body

application/x-www-form-urlencoded
application/json
Object
username
string

Set your bot’s user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

thread_ts
number

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

attachments
string

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

unfurl_links
boolean

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

text
string

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.

unfurl_media
boolean

Pass false to disable unfurling of media content.

parse
string

Change how messages are treated. Defaults to none. See below.

as_user
boolean

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

icon_emoji
string

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.

link_names
boolean

Find and link channel names and usernames.

icon_url
string

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.

channel
string

Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.

reply_broadcast
boolean

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

Responses

500 default

Typical error response if too many attachments are included

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
channel_not_found
not_in_channel
is_archived
msg_too_long
no_text
too_many_attachments
rate_limited
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
Examples
{
  "ok" : false,
  "error" : "too_many_attachments"
}
200 200

Typical success response

Body
application/json
Object
message
objs_message required
ok
defs_ok_true required
ts
defs_ts required
channel
defs_channel required
Examples
{
  "message" : {
    "username" : "ecto1",
    "attachments" : [
      {
        "text" : "This is an attachment",
        "fallback" : "This is an attachment's fallback",
        "id" : 1
      }
    ],
    "text" : "Here's a message for you",
    "ts" : "1503435956.000247",
    "subtype" : "bot_message",
    "type" : "message",
    "bot_id" : "B19LU7CSY"
  },
  "ok" : true,
  "ts" : "1503435956.000247",
  "channel" : "C1H9RESGL"
}
chat_meMessage
POST /chat.meMessage

Authentication

slackAuth
chat:write:user

Share a me message into a channel.

Request headers

token
string optional

Authentication token. Requires scope: chat:write:user

Request body

application/x-www-form-urlencoded
application/json
Object
text
string

Text of the message to send.

channel
string

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

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true,
  "ts" : "1417671948.000006",
  "channel" : "C024BE7LR"
}
GET /chat.getPermalink

Authentication

slackAuth
tokens.basic

Retrieve a permalink URL for a specific extant message

Request parameters

token
string optional

Authentication token. Requires scope: tokens.basic

message_ts
number optional

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

channel
string optional

The ID of the conversation or channel containing the message

Responses

500 default

Error response when channel cannot be found

Body
application/json
unknown
Examples
{ "ok" : false, "error" : "channel_not_found" }
200 200

Standard success response

Body
application/json
Object
permalink
string required
ok
defs_ok_true required
channel
defs_channel required
Examples
{
  "permalink" : "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008",
  "ok" : true,
  "channel" : "C1H9RESGA"
}
chat_delete
POST /chat.delete

Authentication

slackAuth
chat:write:user
chat:write:bot

Deletes a message.

Request headers

token
string optional

Authentication token. Requires scope: chat:write

Request body

application/x-www-form-urlencoded
application/json
Object
as_user
boolean

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.

ts
number

Timestamp of the message to be deleted.

channel
string

Channel containing the message to be deleted.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "message_not_found"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true,
  "ts" : "1401383885.000061",
  "channel" : "C024BE91L"
}
chat_unfurl
POST /chat.unfurl

Authentication

slackAuth
links:write

Provide custom unfurl behavior for user-posted URLs

Request headers

token
string optional

Authentication token. Requires scope: links:write

Request body

application/x-www-form-urlencoded
application/json
Object
user_auth_message
string

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_required
boolean

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

unfurls
string

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

ts
string

Timestamp of the message to add unfurl behavior to.

user_auth_url
string

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

channel
string

Channel ID of the message

Responses

500 default

Typical error response

Body
application/json
unknown
Examples
{ "ok" : false, "error" : "cannot_unfurl_url" }
200 200

Typical, minimal success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
chat_postEphemeral
POST /chat.postEphemeral

Authentication

slackAuth
chat:write:user
chat:write:bot

Sends an ephemeral message to a user in a channel.

Request headers

token
string optional

Authentication token. Requires scope: chat:write

Request body

application/x-www-form-urlencoded
application/json
Object
attachments
string

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

text
string

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.

link_names
boolean

Find and link channel names and usernames.

parse
string

Change how messages are treated. Defaults to none. See below.

user
string

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

as_user
boolean

Pass true to post the message as the authed bot. Defaults to false.

channel
string

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

Responses

500 default

Typical error response

Body
application/json
unknown
Examples
{ "ok" : false, "error" : "user_not_in_channel" }
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
message_ts
defs_ts required
Examples
{
  "ok" : true,
  "message_ts" : "1502210682.580145"
}
chat_update
POST /chat.update

Authentication

slackAuth
chat:write:user
chat:write:bot

Updates a message.

Request headers

token
string optional

Authentication token. Requires scope: chat:write

Request body

application/x-www-form-urlencoded
application/json
Object
attachments
string

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

text
string

New text for the message, using the default formatting rules. It’s not required when presenting attachments.

ts
number

Timestamp of the message to be updated.

parse
string

Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.

as_user
boolean

Pass true to update the message as the authed user. Bot users in this context are considered authed users.

link_names
boolean

Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.

channel
string

Channel containing the message to be updated.

Responses

500 default

Typical error response

Body
application/json
unknown
Examples
{ "ok" : false, "error" : "cant_update_message" }
200 200

Typical success response

Body
application/json
Object
text
string required
ok
defs_ok_true required
ts
defs_ts required
channel
defs_channel required
Examples
{
  "text" : "Updated text you carefully authored",
  "ok" : true,
  "ts" : "1401383885.000061",
  "channel" : "C024BE91L"
}
files.comments
POST /files.comments.edit
POST /files.comments.delete
POST /files.comments.add
files_comments_edit
POST /files.comments.edit

Authentication

slackAuth
files:write:user

Edit an existing file comment.

Request headers

token
string optional

Authentication token. Requires scope: files:write:user

Request body

application/x-www-form-urlencoded
application/json
Object
comment
string

Text of the comment to edit.

id
string

The comment to edit.

file
string

File containing the comment to edit.

Responses

500 default

Standard failure response when used with an invalid token

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
cant_edit
comment_not_found
not_authed
invalid_auth
account_inactive
no_permission
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Standard success response when used with a user token

Body
application/json
Object
comment
objs_comment required
ok
defs_ok_true required
Examples
{
  "user_id" : "W12345678",
  "url" : "https://subarachnoid.slack.com/",
  "team_id" : "T12345678",
  "user" : "grace",
  "team" : "Subarachnoid Workspace",
  "ok" : true
}
files_comments_delete
POST /files.comments.delete

Authentication

slackAuth
files:write:user

Deletes an existing comment on a file.

Request headers

token
string optional

Authentication token. Requires scope: files:write:user

Request body

application/x-www-form-urlencoded
application/json
Object
id
string

The comment to delete.

file
string

File to delete a comment from.

Responses

500 default

Standard failure response when used with an invalid token

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
cant_delete
comment_not_found
not_authed
invalid_auth
account_inactive
no_permission
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "file_not_found"
}
200 200

Standard success response is very simple

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
files_comments_add
POST /files.comments.add

Authentication

slackAuth
files:write:user

Add a comment to an existing file.

Request headers

token
string optional

Authentication token. Requires scope: files:write:user

Request body

application/x-www-form-urlencoded
application/json
Object
comment
string

Text of the comment to add.

file
string

File to add a comment to.

Responses

500 default

Artificial error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
file_not_found
file_deleted
no_comment
cant_add
not_authed
invalid_auth
account_inactive
no_permission
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "file_not_found"
}
200 200

Standard success response

Body
application/json
Object
comment
objs_comment required
ok
defs_ok_true required
Examples
{
  "comment" : {
    "comment" : "Everyone should take a moment to read this file.",
    "created" : 1356032811,
    "timestamp" : 1356032811,
    "user" : "U1234567890",
    "id" : "Fc1234567890",
    "channel" : "C1234467890"
  },
  "ok" : true
}
im
POST /im.close
POST /im.open
POST /im.mark
GET /im.history
GET /im.replies
GET /im.list
im_close
POST /im.close

Authentication

slackAuth
im:write

Close a direct message channel.

Request headers

token
string optional

Authentication token. Requires scope: im:write

Request body

application/x-www-form-urlencoded
application/json
Object
channel
string

Direct message channel to close.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
im_open
POST /im.open

Authentication

slackAuth
im:write

Opens a direct message channel.

Request headers

token
string optional

Authentication token. Requires scope: im:write

Request body

application/x-www-form-urlencoded
application/json
Object
return_im
boolean

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

user
string

User to open a direct message channel with.

include_locale
boolean

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

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
user_not_found
user_not_visible
user_disabled
not_authed
invalid_auth
account_inactive
no_permission
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
team_added_to_org
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
no_op
boolean
already_open
boolean
ok
defs_ok_true required
channel
Object required
last_read
created
string
unread_count
number
is_open
boolean
user
unread_count_display
number
is_im
boolean
id
defs_dm_id required
latest
Examples
{
  "ok" : true
}
im_mark
POST /im.mark

Authentication

slackAuth
im:write

Sets the read cursor in a direct message channel.

Request headers

token
string optional

Authentication token. Requires scope: im:write

Request body

application/x-www-form-urlencoded
application/json
Object
ts
number

Timestamp of the most recently seen message.

channel
string

Direct message channel to set reading cursor in.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
channel_not_found
invalid_timestamp
not_in_channel
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
im_history
GET /im.history

Authentication

slackAuth
im:history

Fetches history of messages and events from direct message channel.

Request parameters

count
integer optional

Number of messages to return, between 1 and 1000.

unreads
boolean optional

Include unread_count_display in the output?

inclusive
boolean optional

Include messages with latest or oldest timestamp in results.

token
string optional

Authentication token. Requires scope: im:history

oldest
number optional

Start of time range of messages to include in results.

channel
string optional

Direct message channel to fetch history for.

latest
number optional

End of time range of messages to include in results.

Responses

500 default

Typical error response

Body
application/json
Object
needed
string
error
string required
Enumeration:
channel_not_found
invalid_ts_latest
invalid_ts_oldest
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
invalid_json
json_not_object
request_timeout
upgrade_required
ok
defs_ok_false required
provided
string
Examples
{
  "ok" : false,
  "error" : "channel_not_found"
}
200 200

Typical success response

Body
application/json
Object
has_more
boolean required
ok
defs_ok_true required
messages
Array of objs_message required
Min items: 1
Unique items: YES
Examples
{
  "has_more" : false,
  "messages" : [
    {
      "text" : "Hello",
      "type" : "message",
      "ts" : "1358546515.000008",
      "user" : "U2147483896"
    },
    {
      "text" : "World",
      "is_starred" : true,
      "type" : "message",
      "ts" : "1358546515.000007",
      "user" : "U2147483896"
    },
    {
      "type" : "something_else",
      "ts" : "1358546515.000007"
    }
  ],
  "ok" : true,
  "latest" : "1358547726.000003"
}
im_replies
GET /im.replies

Authentication

slackAuth
im:history

Retrieve a thread of messages posted to a direct message conversation

Request parameters

thread_ts
number optional

Unique identifier of a thread’s parent message

token
string optional

Authentication token. Requires scope: im:history

channel
string optional

Direct message channel to fetch thread from

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "channel_not_found"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "messages" : [
    {
      "text" : "Hello",
      "type" : "message",
      "ts" : "1358546515.000008",
      "user" : "U2147483896"
    },
    {
      "text" : "World",
      "is_starred" : true,
      "type" : "message",
      "ts" : "1358546515.000007",
      "user" : "U2147483896"
    },
    {
      "type" : "something_else",
      "ts" : "1358546515.000007"
    }
  ],
  "ok" : true
}
im_list
GET /im.list

Authentication

slackAuth
im:read

Lists direct message channels for the calling user.

Request parameters

cursor
string optional

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 for more detail.

token
string optional

Authentication token. Requires scope: im:read

limit
integer optional

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.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
invalid_cursor
not_authed
invalid_auth
account_inactive
no_permission
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
team_added_to_org
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ims
Array of objs_im required
Unique items: YES
ok
defs_ok_true required
Examples
{
  "ims" : [
    {
      "created" : 1449709280,
      "is_user_deleted" : false,
      "is_org_shared" : false,
      "user" : "USLACKBOT",
      "is_im" : true,
      "id" : "D0G9QPY56"
    },
    {
      "created" : 1466692204,
      "is_user_deleted" : false,
      "is_org_shared" : false,
      "user" : "U0G9QF9C6",
      "is_im" : true,
      "id" : "D1KL59A72"
    },
    {
      "created" : 1449722883,
      "is_user_deleted" : false,
      "is_org_shared" : false,
      "user" : "U0G9WFXNZ",
      "is_im" : true,
      "id" : "D0G9XPFH9"
    },
    {
      "created" : 1452098023,
      "is_user_deleted" : false,
      "is_org_shared" : false,
      "user" : "W0HRJL7CK",
      "is_im" : true,
      "id" : "D0HRHJSF7"
    },
    {
      "created" : 1465834222,
      "is_user_deleted" : true,
      "is_org_shared" : false,
      "user" : "U1GDBDGR3",
      "is_im" : true,
      "id" : "D1GD7CHC0"
    },
    {
      "created" : 1468274703,
      "is_user_deleted" : false,
      "is_org_shared" : false,
      "user" : "U1QNSQB9U",
      "is_im" : true,
      "id" : "D1QMF76M9"
    },
    {
      "created" : 1502210225,
      "is_user_deleted" : false,
      "is_org_shared" : false,
      "user" : "U6KR7BVFW",
      "is_im" : true,
      "id" : "D6K48KKRN"
    }
  ],
  "ok" : true,
  "response_metadata" : {
    "next_cursor" : "aW1faWQ6RDBCSDk1RExI="
  }
}
groups
GET /groups.replies
POST /groups.rename
GET /groups.list
POST /groups.kick
POST /groups.mark
GET /groups.info
POST /groups.leave
POST /groups.createChild
POST /groups.invite
POST /groups.create
POST /groups.open
GET /groups.history
POST /groups.setTopic
POST /groups.setPurpose
POST /groups.unarchive
POST /groups.archive
groups_replies
GET /groups.replies

Authentication

slackAuth
groups:history

Retrieve a thread of messages posted to a private channel

Request parameters

thread_ts
number optional

Unique identifier of a thread’s parent message

token
string optional

Authentication token. Requires scope: groups:history

channel
string optional

Private channel to fetch thread from

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "channel_not_found"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "messages" : [
    {
      "text" : "Hello",
      "type" : "message",
      "ts" : "1358546515.000008",
      "user" : "U2147483896"
    },
    {
      "text" : "World",
      "is_starred" : true,
      "type" : "message",
      "ts" : "1358546515.000007",
      "user" : "U2147483896"
    },
    {
      "type" : "something_else",
      "ts" : "1358546515.000007"
    }
  ],
  "ok" : true
}
groups_rename
POST /groups.rename

Authentication

slackAuth
groups:write

Renames a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
validate
boolean

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

name
string

New name for private channel.

channel
string

Private channel to rename

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_list
GET /groups.list

Authentication

slackAuth
groups:read

Lists private channels that the calling user has access to.

Request parameters

exclude_members
boolean optional

Exclude the members from each group

token
string optional

Authentication token. Requires scope: groups:read

exclude_archived
boolean optional

Don’t return archived private channels.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
groups
Array of objs_group required
Min items: 1
Unique items: YES
Examples
{
  "ok" : true
}
groups_kick
POST /groups.kick

Authentication

slackAuth
groups:write

Removes a user from a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
user
string

User to remove from private channel.

channel
string

Private channel to remove user from.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_mark
POST /groups.mark

Authentication

slackAuth
groups:write

Sets the read cursor in a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
ts
number

Timestamp of the most recently seen message.

channel
string

Private channel to set reading cursor in.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
channel_not_found
invalid_timestamp
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_info
GET /groups.info

Authentication

slackAuth
groups:read

Gets information about a private channel.

Request parameters

token
string optional

Authentication token. Requires scope: groups:read

include_locale
boolean optional

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

channel
string optional

Private channel to get info on

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
channel_not_found
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
team_added_to_org
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
group
objs_group required
Examples
{
  "ok" : true
}
groups_leave
POST /groups.leave

Authentication

slackAuth
groups:write

Leaves a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
channel
string

Private channel to leave

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_createChild
POST /groups.createChild

Authentication

slackAuth
groups:write

Clones and archives a private channel.

Request body

application/x-www-form-urlencoded
Object
token
string

Authentication token. Requires scope: groups:write

channel
string

Private channel to clone and archive.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_invite
POST /groups.invite

Authentication

slackAuth
groups:write

Invites a user to a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
user
string

User to invite.

channel
string

Private channel to invite user to.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
channel_not_found
user_not_found
cant_invite_self
is_archived
cant_invite
ura_max_channels
not_authed
invalid_auth
account_inactive
user_is_bot
user_is_ultra_restricted
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
team_added_to_org
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
group
objs_group required
Examples
{
  "ok" : true
}
groups_create
POST /groups.create

Authentication

slackAuth
groups:write

Creates a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
validate
boolean

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

name
string

Name of private channel to create

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
no_channel
restricted_action
name_taken
invalid_name_required
invalid_name_punctuation
invalid_name_maxlength
invalid_name_specials
invalid_name
not_authed
invalid_auth
account_inactive
user_is_bot
user_is_ultra_restricted
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
team_added_to_org
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
group
objs_group required
Examples
{
  "ok" : true
}
groups_open
POST /groups.open

Authentication

slackAuth
groups:write

Opens a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
channel
string

Private channel to open.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_history
GET /groups.history

Authentication

slackAuth
groups:history

Fetches history of messages and events from a private channel.

Request parameters

count
integer optional

Number of messages to return, between 1 and 1000.

unreads
boolean optional

Include unread_count_display in the output?

inclusive
boolean optional

Include messages with latest or oldest timestamp in results.

token
string optional

Authentication token. Requires scope: groups:history

oldest
number optional

Start of time range of messages to include in results.

channel
string optional

Private channel to fetch history for.

latest
number optional

End of time range of messages to include in results.

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
channel_not_found
invalid_ts_latest
invalid_ts_oldest
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
team_added_to_org
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "channel_not_found"
}
200 200

Typical success response

Body
application/json
Object
has_more
boolean required
ok
defs_ok_true required
messages
Array of objs_message required
Min items: 1
Unique items: YES
Examples
{
  "has_more" : false,
  "messages" : [
    {
      "text" : "Hello",
      "type" : "message",
      "ts" : "1358546515.000008",
      "user" : "U2147483896"
    },
    {
      "text" : "World",
      "is_starred" : true,
      "type" : "message",
      "ts" : "1358546515.000007",
      "user" : "U2147483896"
    },
    {
      "type" : "something_else",
      "ts" : "1358546515.000007"
    }
  ],
  "ok" : true,
  "latest" : "1358547726.000003"
}
groups_setTopic
POST /groups.setTopic

Authentication

slackAuth
groups:write

Sets the topic for a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
topic
string

The new topic

channel
string

Private channel to set the topic of

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_setPurpose
POST /groups.setPurpose

Authentication

slackAuth
groups:write

Sets the purpose for a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
purpose
string

The new purpose

channel
string

Private channel to set the purpose of

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_unarchive
POST /groups.unarchive

Authentication

slackAuth
groups:write

Unarchives a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
channel
string

Private channel to unarchive

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
groups_archive
POST /groups.archive

Authentication

slackAuth
groups:write

Archives a private channel.

Request headers

token
string optional

Authentication token. Requires scope: groups:write

Request body

application/x-www-form-urlencoded
application/json
Object
channel
string

Private channel to archive

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
bots
GET /bots.info
bots_info
GET /bots.info

Authentication

slackAuth
users:read

Gets information about a bot user.

Request parameters

token
string optional

Authentication token. Requires scope: users:read

bot
string optional

Bot user to get info on

Responses

500 default

When no bot can be found, it returns an error.

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "bot_not_found"
}
200 200

When successful, returns bot info by bot ID.

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "bot" : {
    "updated" : 1449272004,
    "name" : "commandeer",
    "icons" : {
      "image_36" : "https://...",
      "image_48" : "https://...",
      "image_72" : "https://..."
    },
    "deleted" : false,
    "app_id" : "A061BLERW",
    "id" : "B061F7JQ1"
  },
  "ok" : true
}
users.profile
POST /users.profile.set
GET /users.profile.get
users_profile_set
POST /users.profile.set

Authentication

slackAuth
users.profile:write

Set the profile information for a user.

Request headers

token
string optional

Authentication token. Requires scope: users.profile:write

Request body

application/x-www-form-urlencoded
application/json
Object
profile
string

Collection of key:value pairs presented as a URL-encoded JSON hash.

user
string

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

value
string

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

name
string

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

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_profile"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "profile" : {
    "display_name" : "spengler",
    "status_emoji" : ":books:",
    "team" : "T012AB3C4",
    "real_name" : "Egon Spengler",
    "image_24" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "real_name_normalized" : "Egon Spengler",
    "image_512" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "display_name_normalized" : "spengler",
    "image_32" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "image_48" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "image_72" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "avatar_hash" : "ge3b51ca72de",
    "status_text" : "Print is dead",
    "email" : "spengler@ghostbusters.example.com",
    "image_192" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg"
  },
  "ok" : true
}
users_profile_get
GET /users.profile.get

Authentication

slackAuth
users.profile:read

Retrieves a user’s profile information.

Request parameters

token
string optional

Authentication token. Requires scope: users.profile:read

include_labels
boolean optional

Include labels for each ID in custom profile fields

user
string optional

User to retrieve profile info for

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "user_not_found"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "profile" : {
    "display_name" : "spengler",
    "status_emoji" : ":books:",
    "team" : "T012AB3C4",
    "real_name" : "Egon Spengler",
    "image_24" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "real_name_normalized" : "Egon Spengler",
    "image_512" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "display_name_normalized" : "spengler",
    "image_32" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "image_48" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "image_72" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
    "avatar_hash" : "ge3b51ca72de",
    "status_text" : "Print is dead",
    "email" : "spengler@ghostbusters.example.com",
    "image_192" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg"
  },
  "ok" : true
}
users
POST /users.setPresence
GET /users.info
GET /users.lookupByEmail
GET /users.getPresence
POST /users.deletePhoto
POST /users.setPhoto
GET /users.identity
GET /users.list
POST /users.setActive
users_setPresence
POST /users.setPresence

Authentication

slackAuth
users:write

Manually sets user presence.

Request headers

token
string optional

Authentication token. Requires scope: users:write

Request body

application/x-www-form-urlencoded
application/json
Object
presence
string

Either auto or away

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
users_info
GET /users.info

Authentication

slackAuth
users:read

Gets information about a user.

Request parameters

include_locale
boolean optional

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

token
string optional

Authentication token. Requires scope: users:read

user
string optional

User to get info on

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
user_not_found
user_not_visible
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
team_added_to_org
invalid_json
json_not_object
request_timeout
upgrade_required
Examples
{
  "ok" : false,
  "error" : "user_not_found"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
user
Object required
profile
updated
number required
tz
unknown required
name
string required
deleted
boolean required
is_app_user
boolean required
is_bot
boolean required
tz_label
string required
real_name
string required
locale
string
team_id
defs_team required
is_admin
boolean required
is_ultra_restricted
boolean required
is_owner
boolean required
is_restricted
boolean required
tz_offset
number required
has_2fa
boolean required
id
defs_user required
color
string required
Pattern: ^[a-fA-F0-9]{6}$
is_primary_owner
boolean required
Examples
{
  "ok" : true,
  "user" : {
    "profile" : {
      "display_name" : "spengler",
      "status_emoji" : ":books:",
      "team" : "T012AB3C4",
      "real_name" : "Egon Spengler",
      "image_24" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "real_name_normalized" : "Egon Spengler",
      "image_512" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "display_name_normalized" : "spengler",
      "image_32" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "image_48" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "image_72" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "avatar_hash" : "ge3b51ca72de",
      "status_text" : "Print is dead",
      "email" : "spengler@ghostbusters.example.com",
      "image_192" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg"
    },
    "updated" : 1502138686,
    "tz" : "America/Los_Angeles",
    "name" : "spengler",
    "deleted" : false,
    "is_app_user" : false,
    "is_bot" : false,
    "tz_label" : "Pacific Daylight Time",
    "real_name" : "episod",
    "color" : "9f69e7",
    "team_id" : "T012AB3C4",
    "is_admin" : true,
    "is_ultra_restricted" : false,
    "is_restricted" : false,
    "is_owner" : false,
    "tz_offset" : -25200,
    "has_2fa" : false,
    "id" : "W012A3CDE",
    "is_primary_owner" : false
  }
}
users_lookupByEmail
GET /users.lookupByEmail

Authentication

slackAuth
users:read.email

Find a user with an email address.

Request parameters

token
string optional

Authentication token. Requires scope: users:read.email

email
string optional

An email address belonging to a user in the workspace

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Enumeration:
user_not_found
Examples
{
  "ok" : false,
  "error" : "user_not_found"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
user
defs_user required
Examples
{
  "ok" : true,
  "user" : {
    "profile" : {
      "display_name" : "spengler",
      "status_emoji" : ":books:",
      "team" : "T012AB3C4",
      "real_name" : "Egon Spengler",
      "image_24" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "real_name_normalized" : "Egon Spengler",
      "image_512" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "display_name_normalized" : "spengler",
      "image_32" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "image_48" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "image_72" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
      "avatar_hash" : "ge3b51ca72de",
      "status_text" : "Print is dead",
      "email" : "spengler@ghostbusters.example.com",
      "image_192" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg"
    },
    "updated" : 1502138686,
    "tz" : "America/Los_Angeles",
    "name" : "spengler",
    "deleted" : false,
    "is_app_user" : false,
    "is_bot" : false,
    "tz_label" : "Pacific Daylight Time",
    "real_name" : "episod",
    "color" : "9f69e7",
    "team_id" : "T012AB3C4",
    "is_admin" : true,
    "is_ultra_restricted" : false,
    "is_restricted" : false,
    "is_owner" : false,
    "tz_offset" : -25200,
    "has_2fa" : false,
    "id" : "W012A3CDE",
    "is_primary_owner" : false
  }
}
users_getPresence
GET /users.getPresence

Authentication

slackAuth
users:read

Gets user presence information.

Request parameters

token
string optional

Authentication token. Requires scope: users:read

user
string optional

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

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_false required
error
string required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

When requesting information for a different user, this method just returns the current presence (either active or away).

Body
application/json
Object
manual_away
boolean
presence
string required
last_activity
integer
online
boolean
ok
defs_ok_true required
connection_count
integer
auto_away
boolean
Examples
{
  "ok" : true,
  "presence" : "active"
}
users_deletePhoto
POST /users.deletePhoto

Authentication

slackAuth
users.profile:write

Delete the user profile photo

Request body

application/x-www-form-urlencoded
Object
token
string

Authentication token. Requires scope: users.profile:write

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
users_setPhoto
POST /users.setPhoto

Authentication

slackAuth
users.profile:write

Set the user profile photo

Request body

application/x-www-form-urlencoded
Object
image
string

File contents via multipart/form-data.

crop_w
integer

Width/height of crop box (always square)

token
string

Authentication token. Requires scope: users.profile:write

crop_y
integer

Y coordinate of top-left corner of crop box

crop_x
integer

X coordinate of top-left corner of crop box

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
users_identity
GET /users.identity

Authentication

slackAuth
identity.basic

Get a user’s identity.

Request parameters

token
string optional

Authentication token. Requires scope: identity.basic

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "account_inactive"
}
200 200

You will receive at a minimum the following information:

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true,
  "user" : {
    "name" : "Sonny Whether",
    "id" : "U0G9QF9C6"
  },
  "team" : {
    "id" : "T0G9PQBBK"
  }
}
users_list
GET /users.list

Authentication

slackAuth
users:read

Lists all users in a Slack team.

Request parameters

presence
boolean optional

Whether to include presence data in the output. Setting this to false improves performance, especially with large teams.

cursor
string optional

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 for more detail.

token
string optional

Authentication token. Requires scope: users:read

limit
integer optional

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_locale
boolean optional

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

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_cursor"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "cache_ts" : 1498777272,
  "ok" : true,
  "response_metadata" : {
    "next_cursor" : "dXNlcjpVMEc5V0ZYTlo="
  },
  "members" : [
    {
      "profile" : {
        "display_name" : "spengler",
        "status_emoji" : ":books:",
        "team" : "T012AB3C4",
        "real_name" : "Egon Spengler",
        "image_24" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
        "real_name_normalized" : "Egon Spengler",
        "image_512" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
        "display_name_normalized" : "spengler",
        "image_32" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
        "image_48" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
        "image_72" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg",
        "avatar_hash" : "ge3b51ca72de",
        "status_text" : "Print is dead",
        "email" : "spengler@ghostbusters.example.com",
        "image_192" : "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg"
      },
      "updated" : 1502138686,
      "tz" : "America/Los_Angeles",
      "name" : "spengler",
      "deleted" : false,
      "is_app_user" : false,
      "is_bot" : false,
      "tz_label" : "Pacific Daylight Time",
      "real_name" : "spengler",
      "color" : "9f69e7",
      "team_id" : "T012AB3C4",
      "is_admin" : true,
      "is_ultra_restricted" : false,
      "is_restricted" : false,
      "is_owner" : false,
      "tz_offset" : -25200,
      "has_2fa" : false,
      "id" : "W012A3CDE",
      "is_primary_owner" : false
    },
    {
      "profile" : {
        "first_name" : "Glinda",
        "last_name" : "Southgood",
        "display_name" : "Glinda the Fairly Good",
        "title" : "Glinda the Good",
        "image_1024" : "https://a.slack-edge.com...png",
        "skype" : "",
        "phone" : "",
        "real_name" : "Glinda Southgood",
        "image_24" : "https://a.slack-edge.com...png",
        "image_original" : "https://a.slack-edge.com...png",
        "real_name_normalized" : "Glinda Southgood",
        "image_512" : "https://a.slack-edge.com...png",
        "image_32" : "https://a.slack-edge.com...png",
        "image_48" : "https://a.slack-edge.com...png",
        "image_72" : "https://a.slack-edge.com...png",
        "avatar_hash" : "8fbdd10b41c6",
        "display_name_normalized" : "Glinda the Fairly Good",
        "email" : "glenda@south.oz.coven",
        "image_192" : "https://a.slack-edge.com...png"
      },
      "updated" : 1480527098,
      "tz" : "America/Los_Angeles",
      "name" : "glinda",
      "deleted" : false,
      "is_bot" : false,
      "tz_label" : "Pacific Daylight Time",
      "real_name" : "Glinda Southgood",
      "color" : "9f69e7",
      "team_id" : "T0G9PQBBK",
      "is_admin" : true,
      "is_ultra_restricted" : false,
      "is_restricted" : false,
      "is_owner" : false,
      "tz_offset" : -25200,
      "has_2fa" : false,
      "id" : "W07QCRPA4",
      "is_primary_owner" : false
    }
  ]
}
users_setActive
POST /users.setActive

Authentication

slackAuth
users:write

Marks a user as active.

Request headers

token
string optional

Authentication token. Requires scope: users:write

Responses

500 default

Typical error response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : false,
  "error" : "invalid_auth"
}
200 200

Typical success response

Body
application/json
Object
ok
defs_ok_true required
Examples
{
  "ok" : true
}
conversations
POST /conversations.close
POST /conversations.join
POST /conversations.create
POST /conversations.unarchive
GET /conversations.list
POST /conversations.setTopic
GET /conversations.members
POST /conversations.open
POST /conversations.leave
POST /conversations.kick
POST /conversations.rename
GET /conversations.history
POST /conversations.setPurpose
GET /conversations.info
POST /conversations.invite
POST /conversations.archive
GET /conversations.replies
conversations_close
POST /conversations.close

Authentication

slackAuth
channels:write
groups:write
im:write
mpim:write

Closes a direct message or multi-person direct message.

Request headers

token
string optional

Authentication token. Requires scope: conversations:write

Request body

application/x-www-form-urlencoded
application/json
Object
channel
string

Conversation to close.

Responses

500 default

Typical error response

Body
application/json
Object
needed
string
error
string required
Enumeration:
method_not_supported_for_channel_type
channel_not_found
user_does_not_own_channel
missing_scope
not_authed
invalid_auth
account_inactive
invalid_arg_name
invalid_array_arg
invalid_charset
invalid_form_data
invalid_post_type
missing_post_type
team_added_to_org
invalid_json
json_not_object
request_timeout
upgrade_required
ok
defs_ok_false required
provided
string
Examples
{
  "ok" : false,
  "error" : "channel_not_found"
}
200 200

Typical success response

Body
application/json
Object
no_op
boolean
ok
defs_ok_true required
already_closed
boolean
Examples
{
  "ok" : true
}
conversations_join