POST /admin.users.invite
Invite a user to a workspace.
Servers
- https://slack.com/api
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
token |
String | Yes |
Authentication token. Requires scope: |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
email |
String | Yes |
The email address of the person to invite. |
guest_expiration_ts |
String | No |
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. |
is_restricted |
Boolean | No |
Is this user a multi-channel guest user? (default: false) |
team_id |
String | Yes |
The ID ( |
custom_message |
String | No |
An optional message to send to the user in the invite email. |
real_name |
String | No |
Full name of the user. |
is_ultra_restricted |
Boolean | No |
Is this user a single channel guest user? (default: false) |
channel_ids |
String | Yes |
A comma-separated list of |
resend |
Boolean | No |
Allow this invite to be resent in the future if a user has not signed up yet. (default: false) |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.