Information about required scopes
This Conversations API method's required scopes depend on the type of channel-like object you're working with. To use the method, you'll need at least one of the channels:, groups:, im: or mpim: scopes corresponding to the conversation type you're working with.

Arguments

Argument	Type	Description
`token`Required	token	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`Required	channel	The ID of the public or private channel to invite user(s) to. Example`C1234567890`
`users`Required	users	A comma separated list of user IDs. Up to 1000 users may be listed. Example`W1234567890,U2345678901,U3456789012`

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

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

Typical error response when an invite is attempted on a conversation type that does not support it

{
    "ok": false,
    "error": "method_not_supported_for_channel_type"
}

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

Limits for workspace apps

Because workspace apps can't act on behalf of users, they don't have the power to invite users to conversations, except when they're the owner/creator of the conversation.

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 `users` was invalid.
`no_user`	No value was passed for `users`.
`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.
`too_many_users` [hidden]	Too many users sent in the users arg (max 1000)
`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.
`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.
`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.
`feature_not_enabled` [hidden]	Feature is not enabled for invite all.
`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.
`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.
`not_owner` [hidden]	Only the owner org can invite external users to the channel.
`user_team_not_in_channel` [hidden]	External user's team is not part of the channel
`cant_invite_to_managed_channel` [hidden]	cant invite to managed channel (generated)
`invitee_is_not_a_member_of_this_workspace` [hidden]	invitee is not a member of this workspace (generated)
`subteam_not_found` [hidden]	subteam not found (generated)
`cant_invite_app_user` [hidden]	cant invite app user (generated)
`missing_argument` [hidden]	missing argument (generated)
`user_removed_from_team` [hidden]	user removed from team (generated)
`grpc_getChannelsTS_fail` [hidden]	grpc getChannelsTS fail (generated)
`error` [hidden]	error (generated)
`unsupported_client_version` [hidden]	This API is not supported on this client version - see #incd-210603-4610-ios-leaks-channel-history-when-adding-us
`not_authed`	No authentication token provided.
`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.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`not_allowed_token_type`	The token type used in this request is not allowed.
`method_deprecated`	The method has been deprecated.
`deprecated_endpoint`	The endpoint has been deprecated.
`two_factor_setup_required`	Two factor setup is required.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`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.
`team_access_not_granted`	The token used is not granted the specific workspace access required to complete this request.
`invalid_arguments`	The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.
`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 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.
`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.
`invalid_json` [hidden]	The method was called via a `POST` request with `Content-Type` `application/json`, but the body was not valid JSON.
`json_not_object` [hidden]	The method was called via a `POST` request a valid JSON body, but the JSON value was not an object.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`accesslimited`	Access to this method is limited on the current network
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`upgrade_required` [hidden]	The calling application needs to be upgraded.
`service_unavailable`	The service is temporarily unavailable
`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.

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

Was this page helpful?