POST /user_invites
Creates a user invite and returns the created user invite. User invite link expires 7 days after generation. Requires the users:write scope.
Servers
- https://api.retool.com/api/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
email |
String | Yes |
The email of the invitee |
defaultGroupIds[] |
Array | No |
Group IDs to invite the user to |
metadata |
Object | No |
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.