Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Erase Recipients' Email Data



API Overview

api-overview page anchor

The Recipients' Data Erasure API allows Twilio SendGrid customers to delete their own customers' personal data from the Twilio SendGrid Platform. The use of this API facilitates the self-service removal of email personal data from the Twilio SendGrid platform and will enable customers to comply with various obligatory data privacy regulations.

(error)

Danger

The Recipients' Data Erasure API is available to customers that want to delete their recipients' data. Please file a support ticket(link takes you to an external page) to request access to this API.


POST/v3/recipients/erasejob

Base url: https://api.sendgrid.com

This operation allows you to delete your recipients' personal email data

The Delete Recipients' Email Data operation accepts a list of 5,000 email_addresses or a total payload size of 256Kb per request, whichever comes first. Upon a successful request with this operation, SendGrid will run a search on the email addresses provided against the SendGrid system to identify matches. SendGrid will then delete all personal data associated with the matched users such as the recipients' names, email addresses, subject lines, categories, and IP addresses.

All email addresses are filtered for uniqueness and tested for structural validity—any invalid addresses will be returned in an error response.

Please note that recipient data is deleted for the account making the request only—deletions do not cascade from a parent account to its Subusers' recipients. To delete a Subuser's recipients' data, you can use the on-behalf-of header.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
email_addressesarray[string]required

List of unique recipient email addresses whose PII will be erased. You may include a maximum of 5,000 addresses or a maximum payload size of 256Kb, whichever comes first.

202400401403404429500

The request was accepted for processing

SchemaExample
Property nameTypeRequiredDescriptionChild properties
job_idstring

The job ID associated with the data erasure request.

Erase Recipients' Email Data

erase-recipients-email-data page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_24
const client = require('@sendgrid/client');
_24
client.setApiKey(process.env.SENDGRID_API_KEY);
_24
_24
const data = {
_24
"email_addresses": [
_24
"user1@example.com",
_24
"user2@example.com"
_24
]
_24
};
_24
_24
const request = {
_24
url: `/v3/recipients/erasejob`,
_24
method: 'POST',
_24
body: data
_24
}
_24
_24
client.request(request)
_24
.then(([response, body]) => {
_24
console.log(response.statusCode);
_24
console.log(response.body);
_24
})
_24
.catch(error => {
_24
console.error(error);
_24
});


Rate this page: