Mailboxes
The /mailboxes API enables you to manage mailboxes associated with your account. Use these endpoints to list, retrieve, connect, and update mailboxes, or to review mailbox connection batch status.
Available endpoints
The table below lists every documented endpoint under /rest/v2/mailboxes.
| Endpoint | Method and path | Use it to |
|---|---|---|
| Get a list of mailboxes | GET /rest/v2/mailboxes | Retrieve mailboxes connected to your account |
| Get a mailbox | GET /rest/v2/mailboxes/{id} | Retrieve one SMTP or IMAP mailbox configuration |
| Add mailboxes in bulk | POST /rest/v2/mailboxes/manual_connection/bulk | Connect one or more mailboxes with SMTP and IMAP credentials |
| Mailbox connection batch status | GET /rest/v2/mailboxes/manual_connection/bulk/{batch_id}/summary | Review the status of a submitted mailbox connection batch |
| Update mailbox | PATCH /rest/v2/mailboxes/{smtp_mailbox_id} | Update an SMTP mailbox footer |
| List Microsoft Graph credentials | GET /rest/v2/mailboxes/microsoft/credentials | Retrieve saved Microsoft Graph app-only credentials |
| Create a Microsoft Graph credential | POST /rest/v2/mailboxes/microsoft/credentials | Save tenant and app credentials for Microsoft Graph app-only access |
| Update a Microsoft Graph credential | PATCH /rest/v2/mailboxes/microsoft/credentials/{credential_id} | Rename a credential or rotate its client secret |
| Delete a Microsoft Graph credential | DELETE /rest/v2/mailboxes/microsoft/credentials/{credential_id} | Remove a credential that is not used by an active mailbox |
| Add Microsoft mailboxes in bulk | POST /rest/v2/mailboxes/microsoft/bulk | Connect one or more Microsoft mailboxes with app-only authentication |