Sign in
MailcowOrder

Assign mailbox

post/v1beta/mailcow/orders/assign

Request body

mailboxstring
namestring
passwordstring
reset_passwordboolean
subscription_periodstring

Example request

{
  "domain": {
    "extension": "london",
    "name": "test4"
  },
  "mailbox": "openprovider",
  "name": "",
  "password": "",
  "reset_password": true,
  "subscription_period": "1"
}

Response

A successful response.

codeinteger
descstring
maintenanceboolean

Example response

{
  "code": 0,
  "data": {
    "created_at": "2019-01-01 0:00:01",
    "domain": {
      "extension": "london",
      "name": "test4"
    },
    "expired_at": "2019-01-01 0:00:01",
    "id": 123456789,
    "mailbox": "",
    "mailbox_status": "",
    "owner_handle": "XX123456-XX",
    "quota": 15,
    "quota_used": 10,
    "renew_at": "2019-01-01 0:00:01",
    "status": "",
    "subscription_period": 1
  },
  "desc": ""
}

Changes

Changed in 1 of the 2 revisions of this API.1