Suppressions

Remove a suppression or category opt-out by email query parameter

Changed on
delete/suppressions

Request

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

Query parameters

emailstring email required
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