/conversations.open

POST

/conversations.open

Opens or resumes a direct message or multi-person direct message.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/conversations.open'

Response Example

200 - response

{
    "channel": {
        "id": "D069C7QFK"
    },
    "ok": true
}

Request

Header Params

token

string

optional

Authentication token. Requires scope: conversations:write

Body Params application/x-www-form-urlencoded

channel

string

optional

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

return_im

string

optional

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

users

string

optional

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.

Responses

🟢200Typical success response

application/json

Body

Schema for successful response from conversations.open method when opening channels, ims, mpims

already_open

boolean

optional

channel

array [anyOf]

required

#/components/schemas/objs_conversation

optional

object

optional

no_op

boolean

optional

enum<boolean>

required

Allowed value:

true

🔴500Typical error response

Modified at 2023-08-15 05:39:45

/conversations.members

/conversations.rename