archive group
/members/{member}/groups/{group}/archive [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
Description
Archive the group.
Invoking this service starts an Asynchronous process.
The thread does the following:
- Prefix the group name with ‘archive-’ and add the archive flag.
- Create any missing archive parent project.
- Modify the default group URI and all the URIs below.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| note | Reason for archiving (appended to group description) | no | string |
Permission
This service requires manager or higher.
Response
This service returns the following XML:
<group-archive> <thread ...> ... </thread> </group-archive>
Error Handling
No specific errors expected for this service.
See logs for more details about the effect of this service.