edit group
/members/{member}/groups/{group} [PATCH]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.4101 | 5.9500 | json, xml |
Description
Edits a group.
Edits an existing PageSeeder project/group.
Group settings are only modified for parameters that are set.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| access | Access to group and comments (admin only) [public|member] | no | enum | |
| commenting | Who can comment [public|reviewer|contributor] | no | enum | |
| common | Whether this is a common group. DEPRECATED in PageSeeder v5.99. | no | boolean | |
| defaultnotify | Default notification for new members [immediate|daily|none] | no | enum | |
| defaultproperty.* | Whether group property named * should take the default value | no | boolean | |
| defaultrole | Default role for new members [reviewer|contributor] | no | enum | |
| description | Description of group | no | string | |
| detailstype | The name of the member details config file (admin only) | no | string | |
| editurls | Allow contributors in this group to edit all URLs on the server (admin only) | no | boolean | |
| message | Subscription message | no | string | |
| moderation | Which comments are to be moderated [reviewer|email|all] | no | enum | |
| owner | Owner of group (admin only) | no | string | |
| property.* | Value for group property named * | no | string | |
| registration | Self-registration method [normal|moderated|confirmed] | no | enum | |
| relatedurl | URL of a related website | no | string | |
| template | The template folder for customizations | no | string | |
| title | The user friendly title of group | no | string | |
| visibility | Group name this is visible to or public (admin only) | no | string |
Permission
Requires manager or higher in the group.
Response
<group|project-modification>
<group|project id="123"
name="myproject-mygroup"
[title="My group"]
description="My own group"
owner="My Organisation"
access="[public|member]"
common="[true|false]"
[relatedurl="http://mycompany/mypage.html"]
[visibility="myproject-mygroup"]
[template="myproject"]
[detailstype="mydetails"]
editurls="[true|false]"
commenting="[public|reviewer|contributor]"
moderation="[reviewer|email|all]"
registration="[normal|moderated|confirmed]"
defaultrole="[reviewer|contributor]"
defaultnotify="[immediate|daily|none]" >
<message>Welcome to the group!</message>
</group|project>
</group|project-modification>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x110C | One of the parameters is invalid |