On this page

Delete blocks

API Overview

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.

Operation overview

DELETE/v3/suppression/blocks

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

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

There are two options for deleting blocked emails:

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

Operation details

Authentication

API Key

Headers

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

delete_allbooleanOptional

Indicates if you want to delete all blocked email addresses.

emailsarray[string]Optional

The specific blocked email addresses that you want to delete.

Responses

204

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete blocks

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  "delete_all": false,
6  "emails": [
7    "example1@example.com",
8    "example2@example.com"
9  ]
10};
11
12const request = {
13  url: `/v3/suppression/blocks`,
14  method: 'DELETE',
15  body: data
16}
17
18client.request(request)
19  .then(([response, body]) => {
20    console.log(response.statusCode);
21    console.log(response.body);
22  })
23  .catch(error => {
24    console.error(error);
25  });