The Recipients' Data Erasure API allows Twilio SendGrid customers to delete their own customers' email-related personal data from the Twilio SendGrid Platform. This feature helps customers comply with data privacy regulations.
The Recipients' Data Erasure API isn't enabled for all customers by default.
GET /v3/scopes request. If the recipients.erasejob.read and recipients.erasejob.create scopes are missing, contact Support to enable them.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.
Bearer <<YOUR_API_KEY_HERE>>Optional
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.
application/jsonList 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.
1Max items: 5000The request was accepted for processing
Optional
The job ID associated with the data erasure request.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5email_addresses: ["user1@example.com", "user2@example.com"],6};78const request = {9url: `/v3/recipients/erasejob`,10method: "POST",11body: data,12};1314client15.request(request)16.then(([response, body]) => {17console.log(response.statusCode);18console.log(response.body);19})20.catch((error) => {21console.error(error);22});