admin.users.invite

View other methods

Invite a user to a workspace.

Reference docs Tester

Notices

This API method can only be used on Enterprise Grid workspaces.

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack-gov.com/api/admin.users.invite

Bolt for Java

app.client().adminUsersInvite

Bolt for Python

app.client.admin_users_invite

Bolt for JavaScript

app.client.admin.users.invite

Required scopes

User tokensadmin.users:write

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 2

Arguments

Required arguments

token

token

·Required

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_ids

string

·Required

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

Example

C1A2B3C4D,C26Z25Y24

email

string

·Required

The email address of the person to invite.

Example

joe@email.com

team_id

·Required

The ID (T1234) of the workspace.

Optional arguments

custom_message

string

·Optional

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

Example

Come and join our team!

email_password_policy_enabled

boolean

·Optional

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

Example

true

guest_expiration_ts

string

·Optional

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.

Example

0123456789.012345

is_restricted

boolean

·Optional

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

Example

true

is_ultra_restricted

boolean

·Optional

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

Example

true

real_name

string

·Optional

Full name of the user.

Example

{"full_name":"Joe Smith"}

resend

boolean

·Optional

Allow this invite to be resent in the future if a user has not signed up yet. Resending can only be done via the UI and has no expiration. (default: false)

Example

true

Usage info

This Admin API invites a user to a workspace.

Example responses

Common successful response

Typical success response

{
    "ok": true
}

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
`already_in_team`	The user is already on the team.
`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_send_invite`	The invite failed to send.
`failed_to_validate_caller`	The token calling this method doesn't have permission to invite a user.
`failed_to_validate_channels`	`channel_ids` was invalid.
`failed_to_validate_custom_message`	`extra_message` was invalid.
`failed_to_validate_expiration`	`expiration_ts` was invalid.
`failed_to_validate_team`	The team calling this method was invalid.
`feature_not_enabled`	The Admin APIs feature is not enabled for this team.
`invalid_email`	Email address was not valid.
`not_an_admin`	The user token does not have admin privileges.
`team_not_found`	`team_id` was not found.
`user_disabled`	The user is disabled.
`access_denied`	Access to a resource specified in the request is denied.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`deprecated_endpoint`	The endpoint has been deprecated.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`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.
`is_bot`	This method cannot be called by a legacy bot.
`method_deprecated`	The method has been deprecated.
`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.
`not_authed`	No authentication token provided.
`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.
`token_expired`	Authentication token has expired
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`two_factor_setup_required`	Two factor setup is required.
`accesslimited`	Access to this method is limited on the current network
`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 either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.
`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.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`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
`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.

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