Suppressionsrequires confirm HTTP API
DELETE/api/v1/projects/{project_id}/suppressions/{email}
remove_suppression
Removes an address’s suppressions: every one, or only that of scope. Subscriber statuses are not changed (an unsubscribed subscriber comes back only by resubscribe_subscriber).
- Call it
- when a suppression was made by mistake or no longer applies.
- Needs
- an admin key with
project_id, or a project key with scopewrite(its own project; the argument is ignored), andconfirm: true; without it the call changes nothing and tells what it would do. - Returns
outcome(would_remove,removed),effectnaming the suppressions andsuppressions, whatlist_suppressionswith theemailreturns after the call; the API’sDELETE /api/v1/projects/{project_id}/suppressions/{email}answers 204.
Arguments
- object
-
emailstringrequiredThe suppressed address; any case and surrounding whitespace are normalized.
example
ann@example.com -
confirmbooleantrueremoves. Without it the call only tells what would happen and changes nothing.default
false -
project_idstring · uuid | nullThe project. An admin key must pass it; a project key’s own project is used and this is ignored.
-
scopestringOnly this suppression:
projectorlist:<list_id>; left out: every suppression of the address.example
project
No other arguments are accepted.
Result
The result comes back as structuredContent, with the same JSON as a text block.
- object · all fields required
-
effectstringThe outcome in words, naming what is (or would be) removed.
-
outcomeRemovalOutcomeWhat a removal did.
would_removeA dry run: nothing changed; a call withconfirm: trueremoves.removedRemoved now. -
suppressionsSuppressionsOutputThe address’s suppressions as they are now.
2 fields
- SuppressionsOutput object · all fields required
-
itemsarray of SuppressionBy address, then by scope.
6 fields
- Suppression object · all fields required
-
created_atstring · date-time -
emailstring · email -
project_idstring · uuidThe suppression’s project.
-
reasonstringunsubscribed_all,unsubscribed_list,hard_bounce,soft_bounce_limit,complaintormanual. -
scopestringproject(every list) orlist:<list_id>. -
sourcestringWhere it came from:
api(the API or MCP),web,deliveryorinbound.
-
next_cursorstring | nullPass as
cursorfor the next page;nullon the last page.
Definitions
RemovalOutcome
What a removal did.
string · enum
would_remove A dry run: nothing changed; a call with confirm: true removes.
removed Removed now.
Suppression
An address on the project’s suppression list (GET /api/v1/projects/{project_id}/suppressions, an item).
- object · all fields required
-
created_atstring · date-time -
emailstring · email -
project_idstring · uuidThe suppression’s project.
-
reasonstringunsubscribed_all,unsubscribed_list,hard_bounce,soft_bounce_limit,complaintormanual. -
scopestringproject(every list) orlist:<list_id>. -
sourcestringWhere it came from:
api(the API or MCP),web,deliveryorinbound.
SuppressionsOutput
One page of suppressions (list_suppressions).
- object · all fields required
-
itemsarray of SuppressionBy address, then by scope.
see Suppression
-
next_cursorstring | nullPass as
cursorfor the next page;nullon the last page.
Errors
A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors
HTTP API
The same operation over HTTP: DELETE /api/v1/projects/{project_id}/suppressions/{email}