Suppressions

Retrieve a suppression

Retrieve a suppression by ID or URL-encoded email address.

get/v1/suppressions/{id}

Request

Base URL: https://smtpfa.st/api
URL: https://smtpfa.st/api/v1/suppressions/{id}
Auth: HTTP bearer

Path parameters

idstring required

The suppression ID or URL-encoded email address

Response

Suppression details

objectstring

idstring required

emailstring email required

reason'hard_bounce' | 'complaint' | 'manual' | 'unsubscribe' required

sourcestring required

scope'all' | 'marketing' required

all: every send to the address is blocked. marketing: only marketing email is blocked, and email labelled transactional still goes out. A recipient's own unsubscribe is marketing. Hard bounces, complaints and unsubscribes recorded before marketing-only unsubscribes existed are all. A manual suppression is all unless it was created with scope marketing.

bounce_typestring nullable

diagnostic_codestring nullable

feedback_idstring nullable

email_idstring nullable

event_idstring nullable

created_atstring date-time required

updated_atstring date-time

metadataobject

related_emailobject nullable

related_eventobject nullable

Example response

{
  "object": "suppression",
  "id": "clx_suppression123",
  "email": "blocked@example.com",
  "reason": "hard_bounce",
  "source": "ses",
  "scope": "all",
  "bounce_type": "permanent"
}

Changes

No recorded changes to this operation across all 1 revision of this API.