Skip to main content

​
Mailboxes

Generated reference for Mailboxes endpoints. This generated page groups every public API operation in the Mailboxes category.

​
Endpoints

​
List Mailboxes

GET /v1/public/accounts/{account_id}/mailboxes List Mailboxes List customer mailboxes visible to the public API principal. Full reference: GET /v1/public/accounts/{account_id}/mailboxes
OpenAPI reference: /openapi.en.json GET /v1/public/accounts/{account_id}/mailboxes

​
Export Mailboxes

POST /v1/public/accounts/{account_id}/mailboxes/export Export Mailboxes Export customer mailboxes as CSV. Full reference: POST /v1/public/accounts/{account_id}/mailboxes/export
OpenAPI reference: /openapi.en.json POST /v1/public/accounts/{account_id}/mailboxes/export

​
Create Mailbox

POST /v1/public/accounts/{account_id}/mailboxes Create Mailbox Create a customer mailbox without returning its password. Full reference: POST /v1/public/accounts/{account_id}/mailboxes
OpenAPI reference: /openapi.en.json POST /v1/public/accounts/{account_id}/mailboxes

​
Bulk Create Mailboxes

POST /v1/public/accounts/{account_id}/mailboxes/bulk Bulk Create Mailboxes Create mailboxes in bulk without returning passwords. Full reference: POST /v1/public/accounts/{account_id}/mailboxes/bulk
OpenAPI reference: /openapi.en.json POST /v1/public/accounts/{account_id}/mailboxes/bulk

​
Create Mailbox Alias

POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases Create Mailbox Alias Create an alias for a customer mailbox. Full reference: POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases
OpenAPI reference: /openapi.en.json POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases

​
Reveal Mailbox Credentials

POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials Reveal Mailbox Credentials Reveal customer mailbox credentials for one-time display. Full reference: POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials
OpenAPI reference: /openapi.en.json POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials

​
Get Mailbox

GET /v1/public/accounts/{account_id}/mailboxes/{mailbox} Get Mailbox Return customer mailbox detail. Full reference: GET /v1/public/accounts/{account_id}/mailboxes/{mailbox}
OpenAPI reference: /openapi.en.json GET /v1/public/accounts/{account_id}/mailboxes/{mailbox}

​
Update Mailbox

PATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox} Update Mailbox Update customer mailbox profile fields. Full reference: PATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}
OpenAPI reference: /openapi.en.json PATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}

​
Delete Mailbox

DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox} Delete Mailbox Delete a customer mailbox. Full reference: DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}
OpenAPI reference: /openapi.en.json DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}

​
Delete Mailbox Alias

DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias} Delete Mailbox Alias Delete an alias from a customer mailbox. Full reference: DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}
OpenAPI reference: /openapi.en.json DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}