Slack.Web.Conversations.invite

You're seeing just the function invite, go back to Slack.Web.Conversations module for more information.
Link to this function

invite(channel, users, optional_params \\ %{})

View Source

Invites users to a channel.

Required Params

  • channel - The ID of the public or private channel to invite user(s) to. ex: C1234567890
  • users - A comma separated list of user IDs. Up to 1000 users may be listed. ex: W1234567890,U2345678901,U3456789012

Errors the API can return:

  • account_inactive - Authentication token is for a deleted user or workspace.
  • 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.
  • ekm_access_denied - Administrators have suspended the ability to post a message.
  • 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 called with invalid arguments.
  • 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.
  • 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.
  • 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.
  • is_bot - This method cannot be called by a bot user.
  • method_not_supported_for_channel_type - This type of conversation cannot be used with this method.
  • 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.
  • 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_user - No value was passed for users.
  • not_authed - No authentication token provided.
  • not_in_channel - Authenticated user is not in the channel.
  • org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
  • request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
  • 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.
  • token_revoked - Authentication token is for a deleted user or workspace or the app has been removed.
  • ura_max_channels - URA is already in the maximum number of channels.
  • user_is_ultra_restricted - This method cannot be called by a single channel guest.
  • user_not_found - Value passed for users was invalid.