mailboxes

Create a mailbox

Scope: manage. Claimed (human) accounts only, with an unrestricted credential. 402 plan_limit at the plan's mailbox limit; 422 invalid_name / name_reserved / short_name / invalid_domain / invalid_display_name; 409 name_taken / name_held / name_retired.

post/v1/mailboxes

Request

  • Base URL: https://botmail.pro
  • URL: https://botmail.pro/v1/mailboxes
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bm_session

Request body

namestring required

1-32 chars: a-z, 0-9, '.', '-', '_'; starts and ends with a letter or digit. 4 or fewer chars need a paid plan.

domainstring

A Botmail domain. Defaults to the primary domain.

display_namestring

Response

Created.

idstring required
namestring required
display_namestring required
status'pending' | 'active' | 'suspended' required
addressstring email required

Primary address.

addressesstring[] required

Every address, primary first (paid plans get the name on all domains).

created_atstring date-time required

Changes

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