MAmailcow
Groups

Create group

Changed on

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.

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)
  • Auth
    API key in header X-API-Key

Request body

domainstring

domain of the group (required)

namestring

unique per domain, max. 100 characters

descriptionstring

max. 255 characters

local_partstring

local part of the group address (domain of the group), empty = no address

addressstring

full group address instead of local_part, empty = no address

sender_allowedboolean

members may send as the group address

sogo_visibleboolean

show the group address as SOGo identity (needs sender_allowed)

internalboolean

only accept mail from senders of the domain

template_idnumber

mailbox template applied to the members (admin only), empty = none

prioritynumber

highest priority wins if a mailbox is in several groups with a template (admin only)

activeboolean

Example request

{
  "domain": "example.org",
  "name": "Sales",
  "local_part": "sales",
  "members": [
    "alice@example.org",
    "bob@example.org"
  ],
  "send_as": [
    "shared@example.org"
  ],
  "sender_allowed": "1",
  "active": "1"
}

Response

OK

type'success' | 'danger' | 'warning' | 'error'

Changes