conversations.invite

Invites users to a channel.

Notices

Information about required scopes
This Conversations API method's required scopes depend on the type of channel-like object you're working with. You only need the scopes corresponding to that conversation type, found below in Required scopes.

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack.com/api/conversations.invite

Bolt for Java

app.client().conversationsInvite

Bolt for Python

app.client.conversations_invite

Bolt for JavaScript

app.client.conversations.invite

Required scopes

Bot tokenschannels:write.invitesgroups:write.inviteschannels:managegroups:writeim:writempim:write

User tokenschannels:write.invitesgroups:write.inviteschannels:writegroups:writeim:writempim:write

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 3

Arguments

Required arguments

token

token

·Required

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example

xxxx-xxxxxxxxx-xxxx

channel

string

·Required

The ID of the public or private channel to invite user(s) to.

Example

C1234567890

users

string

·Required

A comma separated list of user IDs. Up to 1000 users may be listed.

Example

W1234567890,U2345678901,U3456789012

Optional arguments

force

boolean

·Optional

When set to true and multiple user IDs are provided, continue inviting the valid ones while disregarding invalid IDs. Defaults to false.

Default

false

Example

true

Usage info

This Conversations API method invites 1-1000 users to a public or private channel. The calling user must be a member of the channel.

Partially failed calls

Users who can be successfully invited and who were not members of the workspace previously will not be invited if any of the user invites fail. Instead, an error response will be returned.

Inviting users who are in a "removed" state (that is, they were once a member of the workspace but have since been removed) will fail “silently”: an error response will be returned via the API, but all other users will be invited except for those in the "removed" state.

Example responses

Common successful response

Typical success response when an invitation is extended

{
    "ok": true,
    "channel": {
        "id": "C012AB3CD",
        "name": "general",
        "is_channel": true,
        "is_group": false,
        "is_im": false,
        "created": 1449252889,
        "creator": "W012A3BCD",
        "is_archived": false,
        "is_general": true,
        "unlinked": 0,
        "name_normalized": "general",
        "is_read_only": false,
        "is_shared": false,
        "is_ext_shared": false,
        "is_org_shared": false,
        "pending_shared": [],
        "is_pending_ext_shared": false,
        "is_member": true,
        "is_private": false,
        "is_mpim": false,
        "last_read": "1502126650.228446",
        "topic": {
            "value": "For public discussion of generalities",
            "creator": "W012A3BCD",
            "last_set": 1449709364
        },
        "purpose": {
            "value": "This part of the workspace is for fun. Make fun here.",
            "creator": "W012A3BCD",
            "last_set": 1449709364
        },
        "previous_names": [
            "specifics",
            "abstractions",
            "etc"
        ]
    }
}

Common error response

Error response when users cannot be invited for differing reasons: one for not being associated with a valid user ID, and one for being the user sending the invite.

{
    "ok": false,
    "error": "user_not_found",
    "errors": [
        {
            "user": "U111111",
            "ok": false,
            "error": "user_not_found"
        },
        {
            "user": "U222222",
            "ok": false,
            "error": "cant_invite_self"
        }
    ]
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error	Description
`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.
`invitee_cant_see_channel`	The Grid 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.
`org_user_not_in_team`	One or more members invited are part of the Enterprise Grid organization but not the specific workspace you're interfacing with.
`method_not_supported_for_channel_type`	This type of conversation cannot be used with this method.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`no_permission`	The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
`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.
`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.
`access_denied`	Access to a resource specified in the request is denied.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`deprecated_endpoint`	The endpoint has been deprecated.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`invalid_auth`	Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
`is_bot`	This method cannot be called by a legacy bot.
`user_is_ultra_restricted`	This method cannot be called by a single channel guest.
`method_deprecated`	The method has been deprecated.
`not_allowed_token_type`	The token type used in this request is not allowed.
`not_authed`	No authentication token provided.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`token_expired`	Authentication token has expired
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`two_factor_setup_required`	Two factor setup is required.
`team_access_not_granted`	The token used is not granted the specific workspace access required to complete this request.
`accesslimited`	Access to this method is limited on the current network
`fatal_error`	The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
`internal_error`	The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.
`invalid_arg_name`	The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.
`invalid_arguments`	The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`invalid_charset`	The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.
`invalid_form_data`	The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.
`invalid_post_type`	The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`service_unavailable`	The service is temporarily unavailable
`team_added_to_org`	The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.

API response

URL

POST body

Submit your arguments to see the API response