User invites
Create v2
Same invite behavior as the first version, but for workspaces billed through Shopify it first checks the subscription's capped amount: if the extra Users would push the charge past the cap, no invite is sent or stored and the response returns the current and the minimum required cap instead.
The pending invites are then kept in a cookie and sent automatically once the higher cap has been approved in Shopify.
POST
/api/{tenant:minlength(2)}/v{version:apiVersion}/user_invites/create_v2
- Authorisation
- Minimum role: ADMIN
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_user_invite_create_response
- 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_create_response
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. |
DTO_capped_amount
| Name | Type | ReadOnly | Description |
|---|
| is_shopify_payment | Boolean | ReadOnly | Is shopify payment |
| current_user_count | Int32 | ReadOnly | Current user count |
| current_invite_count | Int32 | ReadOnly | Current invite count |
| require_increase | Boolean | ReadOnly | Require increase |
| minimum_required_cap | Double | ReadOnly | Minimum required cap |
| current_cap | Double | ReadOnly | Current cap |
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
