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

Delete blocks



API Overview

api-overview page anchor

Blocks happen when your email is rejected because of an issue with the message itself rather than an issue with the recipient's address.

There are several causes for blocked emails. For example, your mail server IP address may be blocked by an ISP, or the receiving server may flag the message content using a filter. Twilio SendGrid will not suppress future messages to blocked addresses by default.

For more information, please see our Blocks documentation.

You can also see your Blocks in the Suppressions settings menu of the Twilio SendGrid App(link takes you to an external page).


DELETE/v3/suppression/blocks

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

This endpoint allows you to delete all email addresses on your blocks list.

There are two options for deleting blocked emails:

  1. You can delete all blocked emails by setting delete_all to true in the request body.
  2. You can delete a selection of blocked emails by specifying the email addresses in the emails array of the request body.

Authentication

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

on-behalf-ofstring

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
delete_allboolean

Indicates if you want to delete all blocked email addresses.


emailsarray[string]

The specific blocked email addresses that you want to delete.

204
Schema

No properties defined

Delete blocks

delete-blocks page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_25
const client = require('@sendgrid/client');
_25
client.setApiKey(process.env.SENDGRID_API_KEY);
_25
_25
const data = {
_25
"delete_all": false,
_25
"emails": [
_25
"example1@example.com",
_25
"example2@example.com"
_25
]
_25
};
_25
_25
const request = {
_25
url: `/v3/suppression/blocks`,
_25
method: 'DELETE',
_25
body: data
_25
}
_25
_25
client.request(request)
_25
.then(([response, body]) => {
_25
console.log(response.statusCode);
_25
console.log(response.body);
_25
})
_25
.catch(error => {
_25
console.error(error);
_25
});


Rate this page: