v4

OpenAPI 3.1.02026-07-3163216290.7 KB

Contacts

Get suppression status for a contact

Retrieve suppression status and removal quota for a contact by email or userId. Include only one query parameter.

get/v1/contacts/suppression

Query parameters

emailstring

Email address (URI-encoded)

userIdstring

Response

Successful.

isSuppressedboolean required

Whether the contact is suppressed.

Example response

{
  "contact": {
    "id": "clh3k9m2p4q6r8s0t2v4x6z8",
    "email": "alex@company.com",
    "userId": "usr_7f8e9d0c1b2a"
  },
  "isSuppressed": false,
  "removalQuota": {
    "limit": 5,
    "remaining": 5
  }
}