conversations.invite

Invites users to a channel.

Supported token types:

user

Expected scopes:

channels:write groups:write im:write mpim:write post

As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For example, a corresponding channels: scope is required when working with public channels.

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

Arguments

This method has the URL https://slack.com/api/conversations.invite and follows the Slack Web API calling conventions.

Present these parameters as part of an application/x-www-form-urlencoded querystring or POST body. application/json is not currently accepted.

Argument	Example	Required	Description
`token`	`xxxx-xxxxxxxxx-xxxx`	Required	Authentication token bearing required scopes.
`channel`	`C1234567890`	Required	The ID of the public or private channel to invite user(s) to.
`users`	`W1234567890,U2345678901,U3456789012`	Required	A comma separated list of user IDs. Up to 30 users may be listed.

Response

    "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" ],
        "num_members": 23,
        "locale": "en-US"
    }
}

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
`channel_not_found`	Value passed for `channel` was invalid.
`user_not_found`	Value passed for `user` was invalid.
`cant_invite_self`	Authenticated user cannot invite themselves to a channel.
`not_in_channel`	Authenticated user is not in the channel.
`already_in_channel`	Invited user is already in the channel.
`is_archived`	Channel has been archived.
`cant_invite`	User cannot be invited to this channel.
`method_not_supported_for_channel_type`	This type of conversation cannot be used with this method.
`missing_scope`	The calling token is not granted the necessary scopes to complete this operation.
`ura_max_channels`	URA is already in the maximum number of channels.
`not_authed`	No authentication token provided.
`invalid_auth`	Invalid authentication token.
`account_inactive`	Authentication token is for a deleted user or workspace.
`user_is_bot`	This method cannot be called by a bot user.
`user_is_ultra_restricted`	This method cannot be called by a single channel guest.
`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_array_arg`	The method was passed a PHP-style array argument (e.g. with a name like `foo[7]`). These are never valid with the Slack API.
`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/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.
`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.
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.

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.