ConnectCloud Developers

Activate (rev 0, creates the address) or switch the platform intake on or off (comms:admin)

PUT /api/comms/v1/mail-intake

Module: Comms · operationId: setMailIntake · Tag: Mailbox import · Auth: access token (Authorization: Bearer <accessToken>)

Request body

application/json (required)

  • enabled (boolean): Switch the intake on or off
  • localPart (string): Part before the @ on activation (default belege) (max length 40)
  • randomSuffix (boolean): Adds a random suffix on activation (default true: a guessable Belege address invites forged invoices)
  • rev (integer): 0 activates the intake

Example:

{
  "enabled": true,
  "localPart": "belege",
  "randomSuffix": true,
  "rev": 0
}

Responses

  • 200 Intake (application/json)
  • 400 Error (application/json)
  • 404 Error (application/json)
  • 409 Error (application/json)

Fields of the 200 answer:

  • address (string): The current address; empty until the intake was activated
  • available (boolean): The platform has a mail domain (else the intake cannot be activated)
  • enabled (boolean): Mail to the address is imported
  • lastImported (integer): Mails received in total
  • lastReceivedAt (string (date-time)): Time of the last received mail
  • mailDomain (string): The tenant's mail domain; empty while the tenant has no subdomain
  • pending (integer): Received mails still waiting for their consumer (state PENDING)
  • previous (array of object): Rotated addresses that are still accepted
    • address (string): The old address
    • validUntil (string (date-time)): Until when it is accepted
  • rev (integer): Revision for optimistic locking; 0 while the intake is not activated
  • updatedAt (string (date-time)): Time of the last change
  • updatedBy (string): Who changed the intake last

Example 200 answer:

{
  "address": "belege-k7m2qa@demo.on.beta.mbcom.dev",
  "available": true,
  "enabled": true,
  "lastImported": 342,
  "lastReceivedAt": "2026-11-18T06:47:12Z",
  "mailDomain": "demo.on.beta.mbcom.dev",
  "pending": 1,
  "previous": [
    {
      "address": "belege-x3p9tz@demo.on.beta.mbcom.dev",
      "validUntil": "2026-11-30T00:00:00Z"
    }
  ],
  "rev": 5,
  "updatedAt": "2026-11-16T10:02:44Z",
  "updatedBy": "christina.adler@muster-it.example"
}

Example request

curl -X PUT 'https://api.mbcom.cloud/api/comms/v1/mail-intake' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"enabled":true,"localPart":"belege","randomSuffix":true,"rev":0}'

View as Markdown · Interactive reference · OpenAPI