Skip to main content
POST
/
v1
/
privacy
/
erase
Erase user data (GDPR Art. 17)
curl --request POST \
  --url https://api.mail.gorillaa.one/v1/privacy/erase \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "anonymize": true
}
'
{
  "data": {
    "email": "[email protected]",
    "erasedAt": "2023-11-07T05:31:56Z",
    "method": "anonymize",
    "result": {
      "emailsAnonymized": 123,
      "eventsAnonymized": 123,
      "suppressionsRemoved": 123,
      "emailsDeleted": 123,
      "eventsDeleted": 123,
      "suppressionsDeleted": 123
    }
  }
}

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
anonymize
boolean
default:true

If true, PII is anonymized rather than hard-deleted

Response

Erasure result

data
object
required