edit subgroup
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.4903 | 5.4903 | json, xml |
Description
Edit an existing subgroup.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| listed | Whether the member’s email address is listed in the group | no | enum | inherit |
| notification | The member’s notification option in the group | no | enum | inherit |
| role | The member¹s role in the group | no | enum | inherit |
notification
The notification parameter must be one of immediate, essential, daily, weekly, none, or inherit.
If not specified, the value inherit is used, meaning that the members inherit the notification settings from the subgroup.
role
The role parameter must be one of guest, reviewer, contributor, manager, approver or inherit.
If not specified, the value inherit is used, meaning that the members inherit the role from the subgroup.
listed
The listed boolean parameter can be used to override the group’s default setting. It affects whether other group members are able to see the subgroup’s members’ user details.
The supported values are true, false and inherit, the default value is inherit, meaning that the members inherit the value from the subgroup.
Permission
This service requires manager or higher.
Response
The XML response returns the modified <subgroup> element wrapping the <group> element acting as the subgroup.
<subgroup-modification>
<subgroup id="[id]"
role="[approver|
manager|
contributor|
reviewer|
guest|
inherit]"
notification="[immediate|
daily|
none|
inherit]"
listed="[true|false|inherit]">
<group id="[group id]" name="[group name]" .../>
</subgroup>
</subgroup-modification>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x110B | Invalid subgroup parameter |
| 0x1109 | Invalid notification parameter |
| 0x110A | Invalid role parameter |