Sample - Slack Web API
POST/conversations.invite

Invite users to a conversation

Invites one or more users to a public or private channel. Provide the destination channel and a comma-separated users list containing the users to invite. The response contains the updated conversation object after the invitation is processed.

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

1 parameter · 2 body fields
tokenstringoptional
Authentication token with the `conversations:write` scope.

Optional invitation request identifying the target channel and comma-separated users to invite.

channelstringoptional
The ID of the public or private channel to invite user(s) to.
usersstringoptional
A comma separated list of user IDs. Up to 1000 users may be listed.

2 status codes
200Returns the updated conversation object after the invitations are extended.
channelarrayrequired
okbooleanrequired
Allowed:true
defaultReturned when invitations are unsupported for the conversation type, the channel or a user cannot be found, a user is already present or cannot be invited, or the invitation exceeds the allowed user limit.
callstackstringoptional
Note: PHP callstack is only visible in dev/qa
errorstringoptional
Allowed:method_not_supported_for_channel_typemissing_scopechannel_not_founduser_not_foundno_usercant_invite_selfnot_in_channelalready_in_channelis_archivedcant_invitetoo_many_usersura_max_channels
errorsarray<object>optional
neededstringoptional
okbooleanrequired
Allowed:false
providedstringoptional

Error handling

channel must identify a public or private channel that supports invitations, and each value in users must be a user identifier. The users list can contain up to 1000 users, and the authentication token must have the conversations:write scope.