boundry.
RegionSydney, Australia
Documentation/getSuppression
GET/suppressions/{suppression_id}

getSuppression

Authentication

This operation does not declare an authentication requirement in the API contract.

Path parameters

NameTypeDescription
suppression_idrequiredstring

Request examples

request.sh
bash
curl --request GET 'https://api.au.boundry.dev/suppressions/string' \
+  -H 'Authorization: Bearer $BOUNDRY_API_KEY' \
+

200 response

Suppression

FieldTypeDescription
idrequiredstring

emailrequiredstring (email)

sourcerequiredunknown

How the address came to be suppressed. `bounce` and `complaint` are written automatically from AWS SES provider events; `manual` is a customer-created entry. Only permanent bounces suppress — a transient bounce (full mailbox, temporary server fault) never does, and neither does a `not-spam` complaint, which is a withdrawal of an earlier complaint. Values: "bounce", "complaint", "manual".

subtypestring | null | null

For `bounce`, the SES bounceSubType (General, NoEmail, Suppressed, OnAccountSuppressionList). For `complaint`, the ARF complaintFeedbackType (abuse, fraud, virus, other). Null for `manual` entries and when the provider did not send one.

reasonstring | null | null

The SMTP diagnostic code for a bounce where SES supplied one, otherwise a short description. Customer-supplied text for `manual` entries.

message_idstring | null | null

The email that caused the suppression. Null for `manual` entries.

created_atrequiredstring (date-time)

response.jsonExample response
application/json
{
  "id": "string",
  "email": "string",
  "source": "bounce",
  "created_at": "string"
}