Cancel a bulk email of a site
cancel_site_email_bulk
Stops a bulk email that is still going out, so whoever it has not reached yet gets nothing.
Every recipient it has not reached yet is canceled and uses none of the allowance, while emails that already went out stay sent. It cannot be resumed, so send a new bulk email to whoever is left. get_site_email_bulk with status set to canceled lists them. It is refused with 409 once the bulk email is no longer sending. It also works on a site that is locked for going over the plan's site limit. See Follow and cancel a bulk email.
Request
Call it with a POST to https://api.modulify.ai/v1/cancel_site_email_bulk, 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/cancel_site_email_bulk \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"PROJECT_ID","id":"ID"}'Over MCP, the same method is the cancel_site_email_bulk tool.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
id |
string | Yes | The id of the bulk email, from send_site_email_bulk or list_site_email_bulks. |
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.