Admin

Admin Users Invite

POST
/admin.users.invite

Invite a user to a workspace.

Authorization

slackAuth admin.users:write
AuthorizationBearer <token>

In: header

Scope: admin.users:write

Header Parameters

token*string

Authentication token. Requires scope: admin.users:write

Content-Type*"application/x-www-form-urlencoded"

Value in

  • "application/x-www-form-urlencoded"

Request Body

application/x-www-form-urlencoded

team_id*string

The ID (T1234) of the workspace.

email*string

The email address of the person to invite.

channel_ids*string

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

custom_message?string

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

real_name?string

Full name of the user.

resend?boolean

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

is_restricted?boolean

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

is_ultra_restricted?boolean

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

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.

Response Body

application/json

application/json

curl -X POST "https://example.com/admin.users.invite" \  -H "token: string" \  -H "Content-Type: application/x-www-form-urlencoded" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'team_id=string&email=string&channel_ids=string'
{  "ok": "True"}