---
title: "Create group"
method: POST
path: "/api/v1/add/mailbox-group"
tags: ["Groups"]
---

# Create group

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

## Request

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

Create a mailbox group (admins; domain admins with the "mailbox_groups" ACL for their domains). With an address the group is a distribution list; its alias is maintained by the group and read-only in the alias API.

## Request body

- object
  - `domain` string: domain of the group (required)
  - `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

## 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/add/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)