Domains
This section shows how to list, create and delete mailbox domains.
List domains in an organization.
The return list can be filtered with request parameters.
query Parameters
order_bypagepage_sizeproject_id(UUID format)
searchList domains in an organization. › Responses
total_countNumber of domains that match the request (without pagination).
Single page of domains matching the requested criteria.
Register a domain in a project.
You must specify a project_id and a domain_name to register a domain in a specific Project.
Register a domain in a project. › Request Body
project_idID of the project to which the domain belongs. (UUID format)
nameFully qualified domain name.
Register a domain in a project. › Responses
idUnique identifier of the domain. (UUID format)
project_idID of the Project to which the domain belongs. (UUID format)
nameFully qualified domain name.
statusStatus of the domain.
mailbox_total_countNumber of mailboxes of the domain.
created_atDate and time of domain creation. (RFC 3339 format)
updated_atDate and time of the domain's last update. (RFC 3339 format)
webmail_urlURL of the domain's webmail.
imap_urlURL of the domain's IMAP service.
pop3_urlURL of the domain's POP3 service.
smtp_urlURL of the domain's SMTP service.
Get a domain by its ID.
path Parameters
domain_idID of the domain to get. (UUID format)
Get a domain by its ID. › Responses
idUnique identifier of the domain. (UUID format)
project_idID of the Project to which the domain belongs. (UUID format)
nameFully qualified domain name.
statusStatus of the domain.
mailbox_total_countNumber of mailboxes of the domain.
created_atDate and time of domain creation. (RFC 3339 format)
updated_atDate and time of the domain's last update. (RFC 3339 format)
webmail_urlURL of the domain's webmail.
imap_urlURL of the domain's IMAP service.
pop3_urlURL of the domain's POP3 service.
smtp_urlURL of the domain's SMTP service.
Delete a domain by its ID.
path Parameters
domain_idID of the domain to delete. (UUID format)
Delete a domain by its ID. › Responses
idUnique identifier of the domain. (UUID format)
project_idID of the Project to which the domain belongs. (UUID format)
nameFully qualified domain name.
statusStatus of the domain.
mailbox_total_countNumber of mailboxes of the domain.
created_atDate and time of domain creation. (RFC 3339 format)
updated_atDate and time of the domain's last update. (RFC 3339 format)
webmail_urlURL of the domain's webmail.
imap_urlURL of the domain's IMAP service.
pop3_urlURL of the domain's POP3 service.
smtp_urlURL of the domain's SMTP service.
Get domain records by its ID.
path Parameters
domain_id(Optional) ID of the domain in which to get the records. (UUID format)
Get domain records by its ID. › Responses
Record designed to automatically configure an email client with the appropriate mail server settings using a standardized XML file format.
Record designed to automate the discovery of server settings to configure email clients like Outlook.
Record that allows clients to interact with calendar data stored on a server.
Record that allows clients to interact with contact data stored on a server.
Record that allows the DKIM email authentication method to be employed to verify the authenticity of an email message.
Record that provides a mechanism for email receivers to determine if incoming messages are legitimate and were sent from authorized sources.
Record that provides a unique token to validate a domain ownership.
Record that allows accessing the mailbox with the IMAP protocol.
Record that directs emails to a mail server.
Record that allows accessing the mailbox with the POP3 protocol.
Record that lists all the servers authorized to send emails from a particular domain.
Record that allows the use of the SMTP submission mechanism.