User invites
Create
Invites up to 25 email addresses to the workspace in one call, all with the same role (only ADMIN or USER) and the same groups, storing one invite per address and emailing each recipient a link that expires after a configured number of hours.
Addresses that are already Users of the workspace or already hold an unexpired invite are rejected, an expired invite that is still marked active is revoked and replaced, and nobody is added to the workspace until they accept.
POST
/api/{tenant:minlength(2)}/v{version:apiVersion}/user_invites/create
- Authorisation
- Minimum role: ADMIN
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_user_invite[]
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_invite_users
| Name | Type | ReadOnly | Description |
|---|
| emails | String[] | | Emails |
| group_ids | Int32[] | | Group ids |
| tenant_role | ENUM tenant_user_role | | Tenant role |
DTO_user_invite
| Name | Type | ReadOnly | Description |
|---|
| groups | DTO_reference[] | | Groups |
| id | Int32 | ReadOnly | Id |
| email | String | | Email |
| tenant_role | ENUM tenant_user_role | | Tenant role |
| expires_date | DateTime | ReadOnly | Expires date |
| expires_relative | String | ReadOnly | Expires relative |
DTO_reference
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | The id of the reference |
| label | Object | ReadOnly | Name/Label from referenced object. |
ENUM tenant_user_role
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | OWNER | Owner |
| 2 | ADMIN | Admin |
| 3 | USER | User |
Generated Aug 4, 2026 18:37
