Mailboxes

Create a mailbox

Create a new mailbox on a verified domain. Setting password also requires mailbox_credentials:write; generate_password needs only mailboxes:write. API keys created before 2026-09-29 may still set password with mailboxes:write alone; that exception is deprecated and will be removed.

post/mailboxes

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

OR

Response

Mailbox created.

object'mailbox' required
idstring required
domain_idstring required
addressstring required
display_namestring nullable required
suspended_atstring date-time nullable required

When the mailbox was suspended. Null if active.

suspension_reasonsstring[] required

Independent reasons currently keeping the mailbox suspended.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "address": "hello@example.com"
}

Changes

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