Update a group (transfer, quota, rename, move department)

Update a group or department. Several actions can be combined in one request; they are executed in this order:

  • new_owner: transfer the group to another user (the new owner is added as member and admin).
  • quota: set the department quota in bytes (> 0, or -2 for unlimited).
  • name: rename the group.
  • target_group_id (new in v13): move a department below another department. Both must be departments (owner system admin); a department cannot be moved into its own sub-department and organization departments cannot be moved. This action returns {"success": true} instead of the group info.

Permission: System admin (is_staff) whose admin role grants can_manage_group. Admin roles with a restricted permission set (e.g. audit_admin, system_admin) receive 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique identifier of a group

Body Params
string

ID/email of the new owner.

integer

Department quota in bytes, -2 = unlimited.

string

New group name.

integer

ID of the department to move this department into.

Responses

400

Invalid parameter (new_owner invalid or already owner, quota invalid., invalid/duplicate name, target_group_id invalid., not a department, Cannot move to its own sub department.).

403

Permission denied: the account is not a system admin, or its admin role lacks the required admin permission. Also returned when moving an organization department.

404

Group, new owner or target department not found.

500

Internal server error.

Language
Credentials
Bearer
Account-Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json