Update group
PATCH
https://example.kaiten.ru/api/latest/company/groups/{uid}| Name | Type | Reference |
|---|---|---|
| uidrequired | string | Group Uid |
| Name | Value |
|---|---|
| Content-Type | application/json |
| Name | Type | Constraints | Description |
|---|---|---|---|
name | string | minLength: 1 maxLength: 512 | Group name |
permissions | integer | Group permissions(bit mask) | |
add_to_cards_and_spaces_enabled | boolean | Ability to add all users of the group to cards, placed in group spaces. Ability to filter logs by group in «Timesheets» |
Detailed info for access permissions and its values
| Access name | Value |
|---|---|
Administrative section "Members" | 1 |
Administrative section "Billing" | 2 |
Administrative section "Company settings" | 4 |
Administrative section "Spaces" | 16 |
Administrative section "Card types" | 32 |
Administrative section "Timesheets"" | 64 |
Allow to read entries of colleagues in the card's Timesheets | 128 |
Administrative section "Export company data" | 256 |
Administrative section "Tags" | 512 |
Allow to invite users into the company | 1024 |
Settings sections of "Service Desk" | 2048 |
Allow to create custom properties for cards | 4096 |
Allow to open public access for cards (share the card) | 8192 |
Allow to convert cards to service desk requests and changing the author | 16384 |
Administrative section "Activity Logs" | 32768 |
Resource planning | 65536 |
Administrative section "Calendars" | 131072 |
Analytics sections of "Service Desk" | 262144 |
Requests section of "Service Desk" | 524288 |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Object |
| Name | Type | Description |
|---|---|---|
| name | string | Group name |
| permissions | integer | Group permissions |
| updated | string | Last update timestamp |
| created | string | Create date |
| id | integer | Group id |
| uid | string | Group uid |
| add_to_cards_and_spaces_enabled | boolean | Ability to add all users of the group to cards, placed in group spaces. Ability to filter logs by group in «Timesheets» |
| Description | Response type | Example |
|---|---|---|
| Validation error | Object |
| Name | Type | Description |
|---|---|---|
| message | string | Error message |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Feature is not supported by tariff | Object |
| Name | Type | Description |
|---|---|---|
| message | string | Error message |
| Description | Response type | Example |
|---|---|---|
| Forbidden | Response body does not exist |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Not found | Response body does not exist |
A schema has not been defined for this response code.
Examples
How to set group permissions. To set permissions you need to sum their values, in the example below permissions are set for the administrative section "Members" and "Billing"
{
"permissions": 3
}
Kaiten
If you have any questions or need help with integration feel free to write us at support@kaiten.io
Path Parameters
1 curl --request PATCH \
2 --url 'https://example.kaiten.ru/api/latest/company/groups/{uid}' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json'
5 Response
ClickTry It!to start a request and see the response here!