---
title: "Update groups"
method: POST
path: "/api/v1/edit/mailbox-group"
tags: ["Groups"]
---

# Update groups

`POST /api/v1/edit/mailbox-group`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/edit/mailbox-group`
- Auth: API key in header `X-API-Key`

Update groups. Attributes you do not send keep their value. Members synced from the identity provider cannot be removed here (group_member_idp).

## Request body

- object
  - `attr` object
    - `name` string: unique per domain, max. 100 characters
    - `description` string: max. 255 characters
    - `local_part` string: local part of the group address (domain of the group), empty = no address
    - `address` string: full group address instead of local_part, empty = no address
    - `members` unknown[]: mailboxes (array or list separated by commas, spaces or newlines); replaces the manual members you may access
      - unknown
    - `send_as` unknown[]: addresses (mailbox or alias) or @domain the members may send as
      - unknown
    - `sender_allowed` boolean: members may send as the group address
    - `sogo_visible` boolean: show the group address as SOGo identity (needs sender_allowed)
    - `internal` boolean: only accept mail from senders of the domain
    - `template_id` number: mailbox template applied to the members (admin only), empty = none
    - `priority` number: highest priority wins if a mailbox is in several groups with a template (admin only)
    - `active` boolean
    - `add_members` unknown[]: mailboxes to add
      - unknown
    - `remove_members` unknown[]: manual members to remove
      - unknown
    - `reapply_template` boolean: apply the effective templates to all members again (admin only)
    - `imap_grants` object[]: replaces the mailbox access of the members (Dovecot ACL on every folder of the mailbox, shown as Shared/<mailbox>); rights read, write or full; you need access to each mailbox; subscribe = the group-grants cron subscribes the folders for every member once (within 15 minutes)
      - `owner` string
      - `rights` 'read' | 'write' | 'full'
      - `subscribe` boolean
    - `sogo_grants` object[]: replaces the SOGo folders shared with the members; folder = SOGo folder ID (default personal); pending until the mailbox opened SOGo once; subscribe = the group-grants cron subscribes every member once (within 15 minutes)
      - `owner` string
      - `type` 'Calendar' | 'Contacts'
      - `folder` string
      - `access` 'read' | 'write'
      - `subscribe` boolean
  - `items` object: contains list of group IDs you want to update

## Response `200`

OK

- object
  - `log` unknown[]: contains request object
    - unknown
  - `msg` unknown[]
    - unknown
  - `type` 'success' | 'danger' | 'warning' | 'error'

## Other responses

- `401`: Unauthorized

## Changes

- **2026-10-27** `c818e639f1cb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/mailcow/apis/mailcow-api/changes/api/v1/edit/mailbox-group/post.md)

---

[API](https://skmtc.dev/mailcow/apis/mailcow-api.md) - [All operations](https://skmtc.dev/mailcow/apis/mailcow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailcow/apis/mailcow-api/revisions/bc8a5589ddad?raw)