Groups / Update
Updates one group.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/groups/{id}
Method: PUT
Authorisation: Minimum role: ADMIN
Response object
Response status: 200 (OK)
Response type: DTO_group
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_group
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| group_users | DTO_reference_user[] | Group users | |
| group_admins | DTO_reference_user[] | Group admins | |
| mailboxes | DTO_reference[] | ReadOnly | Mailboxes |
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| id | Int32 | ReadOnly | Leave empty on input |
| name | String | Name | |
| unique_key | String | Main email key (unique_key@tenant.deskhero.com) Used as forward address, and default group email | |
| forward_to_email | String | ReadOnly | Forward to email |
| type | ENUM group_type | ReadOnly | Type |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
DTO_reference
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| id | Int32 | The id of the reference | |
| label | Object | ReadOnly | Name/Label from referenced object. |
ENUM group_type
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | CUSTOM | Custom |
| 2 | SYSTEM_EVERYONE | Sys everyone |
