Receiving

Create a mailbox

Creates a new mailbox on a receiving domain.

post/receiving/domains/{domain_id}/mailboxes

Request

  • Base URL: https://api.paubox.com/v1/email
  • URL: https://api.paubox.com/v1/email/receiving/domains/{domain_id}/mailboxes
  • Auth: HTTP bearer

Path parameters

domain_idinteger required

Receiving domain ID

Request body

namestring required

Local part of the mailbox address. The full address will be <name>@<domain>.

passwordstring required

Mailbox password.

quota_bytesinteger

Storage quota in bytes. Omit for no quota.

Example request

{
  "name": "support",
  "password": "SecurePass123!",
  "quota_bytes": 1073741824
}

Response

Mailbox created

Example response

{
  "data": {
    "id": 1,
    "name": "support",
    "email_address": "support@company.inbound.paubox.email",
    "quota_bytes": 1073741824
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.