Email Management API¶
Manage mailboxes and quarantined messages, and clawback messages from M365 inboxes.
See the guide for a narrative walkthrough of this API.
Base URL¶
https://api-{dataRegion}.central.sophos.com/email/v1 — Regional service in the production environment.
| Variable | Description | Default | Allowed values |
|---|---|---|---|
dataRegion | The data region where tenant data is stored. | eu01 | eu01, eu02, us01, us03, ca01, au01, jp01, in01, br01, ae01 |
Authentication¶
Every request carries an Authorization: Bearer header with an access token obtained through the client-credentials flow — see Get started.
Operations¶
Clawback¶
See Guide for more on Clawback.
- Clawback message
POST/messages/{id}/clawback - Message status
GET/messages/{id}/status
Mailbox Management¶
- Query Mailboxes
GET/mailboxes - Add mailbox
POST/mailboxes - Add mailboxes
POST/mailboxes/bulk - Delete mailboxes
POST/mailboxes/delete - Get mailbox
GET/mailboxes/{id} - Update name
PATCH/mailboxes/{id} - Delete mailbox
DELETE/mailboxes/{id} - Change aliases
POST/mailboxes/{id}/aliases - Bulk privilege
POST/mailboxes/{id}/bulksender-privilege-request - Change delegates
POST/mailboxes/{id}/delegates - Change DL owners
POST/mailboxes/{id}/distribution-list-owners
Post-Delivery Quarantine¶
See Guide for more on Post-Delivery Quarantine.
- Download job status
GET/post-delivery-quarantine/downloads/{downloadId}/status - Quarantine delete
POST/post-delivery-quarantine/messages/delete - Quarantine release
POST/post-delivery-quarantine/messages/release - Search quarantine
POST/post-delivery-quarantine/messages/search - Get attachments
GET/post-delivery-quarantine/messages/{id}/attachments - Download attachments
POST/post-delivery-quarantine/messages/{id}/attachments/download - Preview message
GET/post-delivery-quarantine/messages/{id}/preview
Quarantine¶
See Guide for more on Quarantine.
- Download job status
GET/quarantine/downloads/{downloadId}/status - Quarantine delete
POST/quarantine/messages/delete - Quarantine release
POST/quarantine/messages/release - Search quarantine
POST/quarantine/messages/search - Get attachments
GET/quarantine/messages/{id}/attachments - Download attachments
POST/quarantine/messages/{id}/attachments/download - Reattach attachments
POST/quarantine/messages/{id}/attachments/reattach - Strip attachments
POST/quarantine/messages/{id}/attachments/strip - Preview message
GET/quarantine/messages/{id}/preview - Get urls
GET/quarantine/messages/{id}/urls
SMIME¶
See Guide for more on SMIME.
- Internal CA certificate info
GET/smime/ca/internal - Create internal CA certificate
POST/smime/ca/internal - Download CA certificate
GET/smime/ca/internal/certificate - Upload internal CA PKCS#12
POST/smime/ca/internal/certificate - External CA certificates info
GET/smime/cas/external - Delete external CA certificate
DELETE/smime/cas/external - Upload trusted CA certificate
POST/smime/cas/external/certificate - Download CA certificate
GET/smime/cas/external/certificate/{fingerprint} - Get S/MIME config
GET/smime/config - Create S/MIME config
POST/smime/config - Update S/MIME config
PATCH/smime/config - Delete S/MIME config
DELETE/smime/config/{deleteToken} - External user certs info
GET/smime/users/external - Delete external user cert
DELETE/smime/users/external - Upload external user cert
POST/smime/users/external/certificate - Download external user cert
GET/smime/users/external/certificate/{fingerprint} - Internal user certificate info
GET/smime/users/internal - Create internal user cert
POST/smime/users/internal - Delete internal user cert
DELETE/smime/users/internal - Upload internal user PKCS#12
POST/smime/users/internal/certificate - Download internal user cert
GET/smime/users/internal/certificate/{fingerprint}
Download¶