Current section
Files
Jump to
Current section
Files
priv/docs/methods/conversations.invite.json
{
"args": {
"channel": {
"desc": "The ID of the public or private channel to invite user(s) to.",
"required": true,
"type": "string"
},
"force": {
"default": "false",
"desc": "When set to `true` and multiple user IDs are provided, continue inviting the valid ones while disregarding invalid IDs. Defaults to `false`.",
"example": "true",
"required": false,
"type": "boolean"
},
"users": {
"desc": "A comma separated list of user IDs. Up to 100 users may be listed.",
"required": true,
"type": "string"
}
},
"desc": "Invites users to a channel.",
"errors": {
"already_in_channel": "Invited user is already in the channel.",
"cant_invite": "User cannot be invited to this channel.",
"cant_invite_self": "Authenticated user cannot invite themselves to a channel.",
"channel_not_found": "Value passed for `channel` was invalid.",
"external_channel_migrating": "External channel migrating.",
"invitee_cant_see_channel": "The Enterprise org multi-workspace channel you are inviting a user to is not shared with any workspaces the user is currently a member of.",
"is_archived": "Channel has been archived.",
"method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.",
"no_external_invite_permission": "User does not have permission to invite that external user to the channel",
"no_user": "No value was passed for `users`.",
"not_in_channel": "Authenticated user is not in the channel.",
"org_user_not_in_team": "One or more members invited are part of the Enterprise organization but not the specific workspace you're interfacing with.",
"ura_max_channels": "An invited user is a single-channel guest user ('ultra restricted access') that is already in the maximum number of conversations.",
"user_is_restricted": "An invited user is a guest user that is restricted from accessing this conversation.",
"user_not_found": "Value passed for `users` was invalid."
},
"rate_limit": {
"label": "Tier 3: 50+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "channels:manage",
"url": "https://docs.slack.dev/reference/scopes/channels.manage"
},
{
"name": "channels:write.invites",
"url": "https://docs.slack.dev/reference/scopes/channels.write.invites"
},
{
"name": "groups:write",
"url": "https://docs.slack.dev/reference/scopes/groups.write"
},
{
"name": "groups:write.invites",
"url": "https://docs.slack.dev/reference/scopes/groups.write.invites"
},
{
"name": "im:write",
"url": "https://docs.slack.dev/reference/scopes/im.write"
},
{
"name": "mpim:write",
"url": "https://docs.slack.dev/reference/scopes/mpim.write"
}
],
"user": [
{
"name": "channels:write",
"url": "https://docs.slack.dev/reference/scopes/channels.write"
},
{
"name": "channels:write.invites",
"url": "https://docs.slack.dev/reference/scopes/channels.write.invites"
},
{
"name": "groups:write",
"url": "https://docs.slack.dev/reference/scopes/groups.write"
},
{
"name": "groups:write.invites",
"url": "https://docs.slack.dev/reference/scopes/groups.write.invites"
},
{
"name": "im:write",
"url": "https://docs.slack.dev/reference/scopes/im.write"
},
{
"name": "mpim:write",
"url": "https://docs.slack.dev/reference/scopes/mpim.write"
}
]
}
}