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.
Scopeconfig:writeDestructive
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.
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. |