mailboxes

Update a mailbox

Scope: manage. Not for pending keys. display_name is the sender name on outgoing mail; empty clears it (mail then shows the mailbox name). The address can't be changed: passing name or address returns 422 address_permanent.

patch/v1/mailboxes/{id}

Request

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

Request body

display_namestring

Response

The updated mailbox.

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.