Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

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 scope write (its own project; the argument is ignored), and confirm: true; without it the call changes nothing and tells what it would do.
Returns
outcome (would_remove, removed), effect naming the suppressions and suppressions, what list_suppressions with the email returns after the call; the API’s DELETE /api/v1/projects/{project_id}/suppressions/{email} answers 204.

Arguments

  • object
  • emailstringrequired

    The suppressed address; any case and surrounding whitespace are normalized.

    example ann@example.com

  • confirmboolean

    true removes. Without it the call only tells what would happen and changes nothing.

    default false

  • project_idstring · uuid | null

    The project. An admin key must pass it; a project key’s own project is used and this is ignored.

  • scopestring

    Only this suppression: project or list:<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
  • effectstring

    The outcome in words, naming what is (or would be) removed.

  • What a removal did.

    would_remove A dry run: nothing changed; a call with confirm: true removes.

    removed Removed now.

  • suppressionsSuppressionsOutput

    The address’s suppressions as they are now.

    2 fields
    • SuppressionsOutput object · all fields required
    • itemsarray of Suppression

      By address, then by scope.

      6 fields
      • Suppression object · all fields required
      • created_atstring · date-time
      • emailstring · email
      • project_idstring · uuid

        The suppression’s project.

      • reasonstring

        unsubscribed_all, unsubscribed_list, hard_bounce, soft_bounce_limit, complaint or manual.

      • scopestring

        project (every list) or list:<list_id>.

      • sourcestring

        Where it came from: api (the API or MCP), web, delivery or inbound.

    • next_cursorstring | null

      Pass as cursor for the next page; null on 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 · uuid

    The suppression’s project.

  • reasonstring

    unsubscribed_all, unsubscribed_list, hard_bounce, soft_bounce_limit, complaint or manual.

  • scopestring

    project (every list) or list:<list_id>.

  • sourcestring

    Where it came from: api (the API or MCP), web, delivery or inbound.

SuppressionsOutput

One page of suppressions (list_suppressions).

  • object · all fields required
  • itemsarray of Suppression

    By address, then by scope.

    see Suppression

  • next_cursorstring | null

    Pass as cursor for the next page; null on 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}