Mailboxes
This section shows how to list, create and delete mailboxes.
Create one or more mailboxes.
Create one or more mailboxes. › Request Body
Parameters for the mailboxes to create.
domain_idID of the domain in which to create the mailboxes. (UUID format)
subscription_periodSubscription renewal period, it can be monthly or yearly.
Create one or more mailboxes. › Responses
List mailboxes in an organization.
The return list can be filtered with request parameters.
query Parameters
order_byOrder matching mailbox by different criteria.
pageRequested page number. Value must be greater or equal to 1.
page_sizeRequested page size. Value must be between 1 and 1000.
domain_id(Optional) ID of the domain in which to list the mailboxes. (UUID format)
(Optional) Filter mailboxes by their statuses.
search(Optional) Search term to filter mailboxes on name and local_part.
List mailboxes in an organization. › Responses
total_countNumber of mailboxes that match the request (without pagination).
Mailboxes matching the requested criteria.
Get a mailbox by its ID.
path Parameters
mailbox_idID of the mailbox to get. (UUID format)
Get a mailbox by its ID. › Responses
idUnique identifier of the mailbox. (UUID format)
domain_idID of the domain to which the mailbox belongs. (UUID format)
emailEmail address of the mailbox as local_part@domain.
statusStatus of the mailbox.
subscription_periodSubscription renewal period, it can be monthly, yearly or canceled if the subscription has been canceled.
subscription_period_started_atDate and time of subscription period start. (RFC 3339 format)
next_subscription_periodNext subscription renewal period, it can be monthly or yearly or canceled if the subscription has been canceled.
next_subscription_period_starts_atDate and time when the next subscription period starts. (RFC 3339 format)
created_atDate and time of mailbox creation. (RFC 3339 format)
updated_atDate and time when the mailbox was last updated. (RFC 3339 format)
deletion_scheduled_atDate and time of the unrecoverable mailbox deletion. (RFC 3339 format)
Delete a mailbox by its ID.
path Parameters
mailbox_idID of the mailbox to delete. (UUID format)
Delete a mailbox by its ID. › Responses
idUnique identifier of the mailbox. (UUID format)
domain_idID of the domain to which the mailbox belongs. (UUID format)
emailEmail address of the mailbox as local_part@domain.
statusStatus of the mailbox.
subscription_periodSubscription renewal period, it can be monthly, yearly or canceled if the subscription has been canceled.
subscription_period_started_atDate and time of subscription period start. (RFC 3339 format)
next_subscription_periodNext subscription renewal period, it can be monthly or yearly or canceled if the subscription has been canceled.
next_subscription_period_starts_atDate and time when the next subscription period starts. (RFC 3339 format)
created_atDate and time of mailbox creation. (RFC 3339 format)
updated_atDate and time when the mailbox was last updated. (RFC 3339 format)
deletion_scheduled_atDate and time of the unrecoverable mailbox deletion. (RFC 3339 format)
Update a mailbox subscription period or password with its ID.
path Parameters
mailbox_idID of the mailbox to update. (UUID format)
Update a mailbox subscription period or password with its ID. › Request Body
subscription_period(Optional) New subscription period for the mailbox.
new_password(Optional) New password of the mailbox.
Update a mailbox subscription period or password with its ID. › Responses
idUnique identifier of the mailbox. (UUID format)
domain_idID of the domain to which the mailbox belongs. (UUID format)
emailEmail address of the mailbox as local_part@domain.
statusStatus of the mailbox.
subscription_periodSubscription renewal period, it can be monthly, yearly or canceled if the subscription has been canceled.
subscription_period_started_atDate and time of subscription period start. (RFC 3339 format)
next_subscription_periodNext subscription renewal period, it can be monthly or yearly or canceled if the subscription has been canceled.
next_subscription_period_starts_atDate and time when the next subscription period starts. (RFC 3339 format)
created_atDate and time of mailbox creation. (RFC 3339 format)
updated_atDate and time when the mailbox was last updated. (RFC 3339 format)
deletion_scheduled_atDate and time of the unrecoverable mailbox deletion. (RFC 3339 format)
Create an alias for a mailbox.
path Parameters
mailbox_idID of the mailbox to associate with the alias. (UUID format)
Create an alias for a mailbox. › Request Body
local_partLocal part of the email address (e.g. local_part@domain.com).
description(Optional) Description of the alias.
Create an alias for a mailbox. › Responses
idUnique identifier of the alias. (UUID format)
emailEmail address of the alias as local_part@domain.
mailbox_idID of the mailbox to which the alias belongs. (UUID format)
descriptionDescription of the alias.
statusCurrent status of the alias.
created_atDate and time of alias creation. (RFC 3339 format)
updated_atDate and time when the alias was last updated. (RFC 3339 format)
Restore a mailbox in deletion scheduled status by its ID.
path Parameters
mailbox_idID of the mailbox to restore. (UUID format)
Restore a mailbox in deletion scheduled status by its ID. › Responses
idUnique identifier of the mailbox. (UUID format)
domain_idID of the domain to which the mailbox belongs. (UUID format)
emailEmail address of the mailbox as local_part@domain.
statusStatus of the mailbox.
subscription_periodSubscription renewal period, it can be monthly, yearly or canceled if the subscription has been canceled.
subscription_period_started_atDate and time of subscription period start. (RFC 3339 format)
next_subscription_periodNext subscription renewal period, it can be monthly or yearly or canceled if the subscription has been canceled.
next_subscription_period_starts_atDate and time when the next subscription period starts. (RFC 3339 format)
created_atDate and time of mailbox creation. (RFC 3339 format)
updated_atDate and time when the mailbox was last updated. (RFC 3339 format)
deletion_scheduled_atDate and time of the unrecoverable mailbox deletion. (RFC 3339 format)