Clear the email history of a site
clear_site_email_history
Clears the whole email history of a site, while sending, this month's allowance and the blocked addresses stay as they are.
Every email the site sent disappears from list_site_email_sends, the stats, the Emails tab and the site's own getEmail and listEmails, and the cleared rows are erased for good 30 days later. Sending keeps working, and this month's allowance and the blocked addresses do not change.
There is no undo, so the tool tells the client to confirm with you first. Export history in the danger zone of the Emails tab downloads a full copy first, and with an access token, over MCP or the HTTP API, list_site_email_sends pages through the same history. It needs the Delete projects permission. See Danger zone.
Request
Call it with a POST to https://api.modulify.ai/v1/clear_site_email_history, sending the inputs below as a JSON object. The token needs the config:write scope.
This method is marked destructive: it deletes or overwrites data. Check the inputs before you call it, and send an Idempotency-Key header whenever you might retry it.
curl -X POST https://api.modulify.ai/v1/clear_site_email_history \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"PROJECT_ID"}'Over MCP, the same method is the clear_site_email_history tool.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
Response
Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.