User invites / Create v2
Invite user(s) to tenant
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/user_invites/create_v2
Method: POST
Authorisation: Minimum role: ADMIN
Response object
Response status: 200 (OK)
Response type: DTO_user_invite_create_response
Wrapper: DTO_response_wrap
Other response 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
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| invites | DTO_user_invite[] | Invites | |
| capped_amount | DTO_capped_amount | Capped amount |
DTO_user_invite
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| groups | DTO_reference[] | Groups | |
| id | Int32 | ReadOnly | Id |
| String | |||
| 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 |
