Domains and mailboxes
Learn how to manage and customize domains and mailboxes to collect payables in a single place and automatically upload them to the Monite platform.
The email size limit is 25 MB for each inbound email message (including attachments).
Monite automatically creates mailboxes for partners. These mailboxes are on Monite’s domain—monite.com; thus, the email address on all Monite emails is always noreply@monite.com by default. However, partners can opt to set up their email domain for better convenience.
Once a domain is created and verified, for example, mycompany.com, the emails Monite sends will also have noreply@mycompany.com in the from header by default. This custom domain will also be displayed in the email’s mailed-by and signed-by MIME headers.
You can customize the email sender name and username by updating your Monite partner settings. For more information, see Update partner settings.
If the entity users already have their own custom emails shared with their vendors to collect their payables, the entity users can automatically forward their received emails to a mailbox of the partner, where the payables will be collected.
The following endpoints must be accessed using a partner access token:
/mailbox_domains*GET /mailboxes/searchThe following endpoints can be accessed using both partner tokens and entity user access tokens. Entity users need a role with the mailbox permissions to access these endpoints.
GET /mailboxesPOST /mailboxesDELETE /mailboxes/{mailbox_id}To list all the domains registered in the system, send a GET request to the /mailbox_domains endpoint:
The successful response contains information about the domains registered in the system:
To create a new domain, send a POST request to the /mailbox_domains endpoint:
Different domains per environment
You must use different domain names in the Sandbox and Production environments. For example, mail.sandbox.mycompany.com in Sandbox and mail.mycompany.com in Production.
You cannot create a Production domain with the same domain name as in Sandbox, and vice versa.
The successful response contains information about the created domain:
After receiving the required DNS records in the previous step, you have to enter these settings in the control panel of your domain provider.
The mail service provider used by Monite automatically verifies the associated domains on a regular basis (one or more times a day).
However, you can also trigger domain verification manually by calling POST /mailbox_domains/{domain_id}/verify:
In case of successful verification, the response will return status set to verified:
If the verification fails, the response will contain status set to waiting_to_be_verified. To resolve this issue, ensure the DNS records required for this mailbox domain match the records you provided in the control panel of your domain provider in the previous step.
It is not possible to update an existing domain. If some data has to be changed, you need to delete the domain and then create it again. To delete a domain, call DELETE /mailbox_domains/{domain_id}:
The successful response indicates that the domain was deleted successfully.
After you have added your custom domain to Monite, you can associate specific mailboxes within this domain with specific entities.
These entity mailboxes are not created by default and, thus, need to be created by the partners. The domain should be verified.
The mailbox name can contain only lowercase letters (from a to z), digits (from 0 to 9), and the characters ., _, +, and -.
To associate a mailbox with an entity, call POST /mailboxes as shown below. The mailbox_name field represents the part of the email address before the @ and the mailbox_domain_id field represents the ID of the domain that you previously added:
The response contains the full email address (mailbox_full_address) associated with this entity:
Now the entity can receive invoices to this mailbox. Any invoices sent as email attachments to this mailbox will be registered as new payables for that entity and trigger the related approval policies. You can also set mailboxes for collecting receipts.
To retrieve all the mailboxes used to process payables of the connected entity, call GET /mailboxes:
The successful response contains a list of all the mailboxes associated with this entity:
Partners can list all the mailboxes of a given list of entity IDs by calling POST /mailboxes/search.
It is not possible to update an existing mailbox. If some data has to be changed, you need to delete the mailbox and then create it again. To delete a mailbox, call DELETE /mailboxes/{mailbox_id}:
The successful response indicates that the mailbox was deleted successfully.