Invite a user to a workspace.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/admin.users.invite
Bolt for Java
app.client().adminUsersInvite
Powered by Bolt
Bolt for Python
app.client.admin_users_invite
Powered by Bolt
Bolt for JavaScript
app.client.admin.users.invite
Powered by Bolt

Content types

application/x-www-form-urlencodedapplication/json
  • Rate limits

    Tier 2
  • Arguments

    ArgumentTypeDescription
    tokenRequired

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

    Examplexxxx-xxxxxxxxx-xxxx
    channel_idsRequired
    string

    A comma-separated list of channel_ids for this user to join. At least one channel is required.

    ExampleC1A2B3C4D,C26Z25Y24
    string

    The email address of the person to invite.

    Examplejoe@email.com
    team_idRequired

    The ID (T1234) of the workspace.

    custom_message
    string

    An optional message to send to the user in the invite email.

    ExampleCome and join our team!
    boolean

    Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.

    Exampletrue
    guest_expiration_ts
    string

    Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.

    Example0123456789.012345
    is_restricted
    boolean

    Is this user a multi-channel guest user? (default: false)

    Exampletrue
    is_ultra_restricted
    boolean

    Is this user a single channel guest user? (default: false)

    Exampletrue
    real_name
    string

    Full name of the user.

    Example{"full_name":"Joe Smith"}
    resend
    boolean

    Allow this invite to be resent in the future if a user has not signed up yet. (default: false)

    Exampletrue

    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

    {
        "ok": true
    }

    This Admin API invites a user to a workspace.

    This API method for admins may only be used on Enterprise Grid.

    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.

    ErrorDescription
    team_not_found

    team_id was not found.

    feature_not_enabled

    The Admin APIs feature is not enabled for this team.

    invalid_email

    Email address was not valid.

    already_in_team

    The user is already on the team.

    user_disabled

    The user is disabled.

    already_in_team_invited_user

    The user has already been invited to the team.

    failed_looking_up_user

    We couldn't find the requested user.

    failed_to_validate_caller

    The token calling this method doesn't have permission to invite a user.

    failed_to_validate_team

    The team calling this method was invalid.

    failed_to_validate_channels

    channel_ids was invalid.

    failed_to_validate_expiration

    expiration_ts was invalid.

    failed_to_validate_custom_message

    extra_message was invalid.

    failed_to_send_invite

    The invite failed to send.

    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.

    token_expired

    Authentication token has expired

    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.

    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.

    missing_scope

    The token used is not granted the specific scope permissions required to complete this request.

    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.

    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.

    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.

    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.

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

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response

    Was this page helpful?