Skip to content
ShipSquares

/mail/domains/{id}/mailboxes (POST)

POST
/mail/domains/{id}/mailboxes
 
curl --request POST \
  --url https://example.com/api/v1/mail/domains/example/mailboxes \
  --header 'Content-Type: application/json' \
  --data '{ "localPart": "example", "displayName": "example", "quotaBytes": 1, "password": "example" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
localPart
required
string
>= 1 characters <= 64 characters
displayName
string
<= 200 characters
quotaBytes
integer
password
string
>= 8 characters <= 1024 characters
Example generated
{
  "localPart": "example",
  "displayName": "example",
  "quotaBytes": 1,
  "password": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Default Response

Media type application/json
object
mailbox
required
object
id
required
string
mailDomainId
required
string
localPart
required
string
displayName
required
Any of:
string
quotaBytes
required
Any of:
integer
status
required
string
createdAt
required
string
password
required
string
Example generated
{
  "mailbox": {
    "id": "example",
    "mailDomainId": "example",
    "localPart": "example",
    "displayName": "example",
    "quotaBytes": 1,
    "status": "example",
    "createdAt": "example"
  },
  "password": "example"
}

400

Section titled “400 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

404

Section titled “404 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}