SLSmartletter API

Suppressions

Addresses that never receive anything from your workspace.

get/suppressions— List suppressions

Keys: full_access

Query parameters

reason"bounced" | "complained" | "user_unsub" | "admin" | "gdpr"
limitinteger1–100, default 20.
afteruuidId of the last item of the previous page (older items).
beforeuuidId of the first item of the previous page (newer items).
curl -X GET https://api.smartletter.ai/suppressions \
  -H "Authorization: Bearer $SMARTLETTER_API_KEY"

Response 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "suppression",
      "id": "5b1f2c90-0000-4000-8000-000000000002",
      "email": "old@example.com",
      "reason": "admin"
    }
  ]
}

post/suppressions— Suppress an address

Keys: full_access

Body

emailrequiredstring
reason"bounced" | "complained" | "user_unsub" | "admin" | "gdpr"
notesstring
curl -X POST https://api.smartletter.ai/suppressions \
  -H "Authorization: Bearer $SMARTLETTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"old@example.com","reason":"gdpr"}'

Response 201

{
  "object": "suppression",
  "id": "5b1f2c90-0000-4000-8000-000000000002",
  "email": "old@example.com",
  "reason": "gdpr"
}

delete/suppressions/{id}— Lift a suppression

Bounces and spam complaints can never be lifted (409).

Keys: full_access

curl -X DELETE https://api.smartletter.ai/suppressions/<id> \
  -H "Authorization: Bearer $SMARTLETTER_API_KEY"

Response 200

{
  "object": "suppression",
  "id": "5b1f2c90-0000-4000-8000-000000000002",
  "deleted": true
}