Sample - Slack Web API
POST/conversations.open

Open or resume a direct conversation

Opens or resumes a direct message or multi-person direct message. Supply an existing direct conversation in channel, or provide one or more user IDs in users; use return_im when the full direct-message channel definition is needed in the response.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 3 body fields
tokenstringoptional
Authentication token for the request; it must provide the `conversations:write` scope.

Optional form-encoded parameters for opening or resuming a direct conversation.

channelstringoptional
Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.
usersstringoptional
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`.
return_imbooleanoptional
Boolean, indicates you want the full IM channel definition in the response.

2 status codes
200Returns a success object with the opened or resumed conversation in `channel`, and may include `already_open` or `no_op` indicators.
already_openbooleanoptional
channelarrayrequired
no_opbooleanoptional
okbooleanrequired
Allowed:true
defaultTypical error response
callstackstringoptional
Note: PHP callstack is only visible in dev/qa
errorstringrequired
Allowed:method_not_supported_for_channel_typeuser_not_founduser_not_visibleuser_disabledusers_list_not_suppliednot_enough_userstoo_many_usersinvalid_user_combinationnot_authedinvalid_authaccount_inactiveinvalid_arg_name
okbooleanrequired
Allowed:false

Error handling

Provide either channel or users: channel must identify an existing direct or multi-person direct message, while users must contain a comma-separated user list. The token must provide the conversations:write scope when supplied for authentication.