Suppressions

Remove a suppression by id or address

Changed on

{id} is the suppression id, or the suppressed address itself (DELETE /suppressions/user@example.com, URL-encoded if your client requires it). With type=category_opt_out, {id} is a category opt-out id or the address. Returns 404 when nothing matches.

delete/suppressions/{id}

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/suppressions/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Suppression id (or category opt-out id with type=category_opt_out), or the email address

Query parameters

tenantstring

Remove it from this tenant's list instead of the account-wide list.

type'suppression' | 'category_opt_out'

category_opt_out works on category opt-outs (a reader's one-click unsubscribe from product or newsletter email) instead of the suppression list.

category'product' | 'newsletter'

With type=category_opt_out, remove only this category. Omit to remove every category for the address.

Response

Suppression (or category opt-out) removed

okboolean required
deletedinteger

With type=category_opt_out, how many opt-outs were removed.

Changes

  • 479821c9fecfRevision changes
    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter type

    • info

      added the optional property to the response with the status