Delete Email Address
Despite the name, this does not delete the email address — it disables it. The address stays assigned to the company, stops receiving mail, and can be reactivated later for the same company. Like Assign Email Address, this is called with a company token, not the partner JWT, and the company must have an active ADMIN user.
Endpoint
| Property | Value |
|---|---|
| URL | DELETE /smtp/account/{emailAddress}/delete |
| Method | DELETE |
| Auth | R-Auth: <company-jwt> (Administrator role required) |
| Base URL | Stage Environment https://api-stage.docnova.ai/ Production Environment https://api.docnova.ai/ |
Example Request
curl --location --request DELETE '{{baseUrl}}/smtp/account/{{emailAddress}}/delete' \
--header 'R-Auth: {{companyJwt}}'
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
emailAddress | string | Yes | The email address to disable |
Request fields
This endpoint takes no request body.
Response
sales-team@mail.example.com
Response fields
| Field | Type | Description |
|---|---|---|
(body) | string | The disabled email address. The response is a plain text value, not a JSON object. |
The address is marked active: false and disabledAt is set — the record itself is kept, not removed.
- If SES is enabled for the environment, the address moves to
PENDING_DEACTIVATIONand a background reconciler removes it from the mail-receiving rule. This is asynchronous: a200response does not guarantee mail has stopped yet, only that it will by the next scheduled run. - Otherwise, a filter rule is added that rejects incoming mail to the address and notifies the sender it was not delivered.
The address still belongs to the company, so another company that tries to claim it gets 409. The same company can reactivate it by calling Assign Email Address with the same local part. While disabled, the address does not count against the plan's email address limit — the limit only counts active addresses.
Response Codes
| Code | Description |
|---|---|
200 | OK — Returns the disabled email address |
400 | Bad Request — Email receiving is not configured for this environment |
401 | Unauthorized — R-Auth header missing or invalid, company does not have an active ADMIN user, or the token is restricted to a different company than the one the address belongs to |
404 | Not Found — Address does not exist, or is already disabled |
Calling this endpoint again on an already-disabled address returns 404, not 200. Treat 404 as "already disabled" rather than as an error.
Offboarding a company
When a company revokes consent or is offboarded, disable all of its addresses:
- List the company's addresses with List Email Addresses.
- Call this endpoint for each address that is still
active. - Treat any
404response as "already disabled" and continue.