Add Suppression

Add an email to the suppression list.

POST /api/v1/suppression

Add Suppression

cURL

curl --request POST \
  --url https://api.example.com/api/v1/suppression/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "reason": "<string>"
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "created_at": "<string>",
  "reason": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

email · string · required

reason · string | null

Response

201

application/json

Successful Response

id · string<uuid> · required

email · string · required

created_at · string · required

reason · string | null