You must enable javascript in order to use the Slack API Documentation. You can do this in your browser settings.
Go to Slack

groups.invite

Invites a user to a private channel.

Supported token types:
Expected scopes:

This method is used to invite a user to a private channel. The calling user must be a member of the private channel.

To invite a new member to a private channel without giving them access to the archives of the private channel, call the groups.createChild method before inviting.

Arguments

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

Argument Example Required Description
token xxxx-xxxxxxxxx-xxxx Required

Authentication token bearing required scopes.

channel G1234567890 Required

Private channel to invite user to.

user W1234567890 Required

User to invite.

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

Response

If successful, the API response includes a group object:

{
    "ok": true,
    "group": {
        …
    },
}

If the invited user is already in the private channel, the response will include an already_in_group property:

{
    "ok": true,
    "already_in_group": true,
    "group": {
        …
    },
}

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 group.

is_archived

Group has been archived.

cant_invite

User cannot be invited to this group.

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.

no_permission

The workspace token used in this request does not have the permissions necessary to complete the request.

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.