WoyraDocs
Get an API key

Create a mailbox

POST/v1/mailboxes

Mailboxes · Requires an API key

Creates a Woyra Mail mailbox, local_part@domain, on one of the account's sending domains. The domain must be verified: a mailbox on an unproven domain could never send, and its owner would find that out from a bounce. Mail to the address is delivered once the domain's MX record points at Woyra.

Addresses are unique across mailboxes and aliases, and lower-case. Requires mailboxes:manage.

**Price.** A mailbox costs $3.49 a month with 10 GB, sending included, charged from the account's balance: the first month when it is created, then monthly. A balance that does not cover the first month gets 402 insufficient_funds and no mailbox. Nothing is refunded on deletion; a month is what was bought. Partners that resell Woyra Mail are billed wholesale instead and pay nothing per mailbox here.

Body

FieldTypeDescription
domain_idrequiredstring
local_partrequiredstringThe part before the @. 1-64 letters, digits, dots, hyphens, underscores or plus signs, starting and ending with a letter or digit. Lower-cased.
quota_bytesintegernullStorage limit in bytes. A mailbox includes 10 GB (10737418240), which is also the default and the most a directly billed mailbox may have.
passwordstringLets the mailbox's owner sign in to Woyra Mail directly (POST /v1/mail/auth/token). Leave it out for a mailbox reached only through a partner such as TalariCloud, which exchanges its key for a token instead.

Example

curl -X POST https://api.woyra.io/v1/mailboxes \
  -H "Authorization: Bearer $WOYRA_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: create-mailbox-1' \
  -d '{
    "domain_id": "<domain_id>",
    "local_part": "<local_part>"
  }'

Response

201 The mailbox.

FieldTypeDescription
objectrequired"mailbox"
idrequiredstring
addressrequiredstring
domain_idrequiredstring
quota_bytesrequiredintegernullNull is no quota.
suspendedrequiredbooleanDelivery stopped; mail retained.
suspended_attimestamp
has_passwordrequiredbooleanWhether someone can sign in to the mailbox directly.
past_duerequiredbooleanThe monthly charge could not be taken from the balance. Mail still arrives; signing in and sending resume once a top-up clears it.
created_atrequiredtimestamp

Errors

StatusCodes
400invalid_request, unsupported_version
401authentication_required, invalid_api_key
402insufficient_funds, spend_cap_exceeded, email_limit_reached
403insufficient_scope, domain_not_verified, recipient_suppressed, sending_paused, mfa_required

Also in Mailboxes