admin.users.invite
Invite a user to a workspace.
Facts
Method URL: | https://slack.com/api/admin.users.invite | ||||
---|---|---|---|---|---|
Preferred HTTP method: | POST | ||||
Accepted content types: | application/x-www-form-urlencoded , application/json | ||||
Rate limiting: | Tier 2 | ||||
Works with: |
|
This Admin API invites a user to a workspace.
This API method for admins may only be used on Enterprise Grid.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
channel_ids
A comma-separated list of channel_id
s for this user to join. At least one channel is required.
C1A2B3C4D,C26Z25Y24
email
The email address of the person to invite.
Examplejoe@email.com
team_id
The ID (T1234
) of the workspace.
custom_message
An optional message to send to the user in the invite email.
ExampleCome and join our team!
guest_expiration_ts
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
Is this user a multi-channel guest user? (default: false)
Exampletrue
is_ultra_restricted
Is this user a single channel guest user? (default: false)
Exampletrue
real_name
Full name of the user.
Example{"full_name":"Joe Smith"}
resend
Allow this invite to be resent in the future if a user has not signed up yet. (default: false)
Exampletrue
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
Response
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 |
---|---|
team_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 |
|
failed_to_validate_expiration |
|
failed_to_validate_custom_message |
|
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. |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed. |
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 |
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 |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
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 |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
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 |
superfluous_charset | The method was called via a |