Skip to main content
POST
/
v1
/
suppressions
Add a manual suppression
curl --request POST \
  --url https://api.mail.gorillaa.one/v1/suppressions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "reason": "manual",
  "notes": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]",
    "reason": "hard_bounce",
    "source": "<string>",
    "suppressedAt": "2023-11-07T05:31:56Z",
    "notes": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your Gorillaa Mail API key as a Bearer token.

Example: Authorization: Bearer grl_live_xxxxxxxxxxxx

Keys prefixed grl_test_ operate in test mode with reduced limits.

Body

application/json
​
email
string<email>
required
​
reason
enum<string>
required

Only manual and unsubscribe are allowed via API

Available options:
manual,
unsubscribe
​
notes
string
Maximum string length: 500

Response

Suppression entry created

​
data
object
required

Created suppression entry (does not include expiresAt)