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

Retrieve a specific block



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).


GET/v3/suppression/blocks/{email}

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

This endpoint allows you to retrieve a specific email address from your blocks list.


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.

Property nameTypeRequiredDescription
emailstring<email>required

The email address of the specific block.

200
SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties
createdinteger

A Unix timestamp indicating when the email address was added to the blocks list.


emailstring<email>

The email address that was added to the block list.


reasonstring

An explanation for the reason of the block.


statusstring

The status of the block.

Retrieve a specific block

retrieve-a-specific-block page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_19
const client = require('@sendgrid/client');
_19
client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19
const email = "brian12@example.net";
_19
_19
const request = {
_19
url: `/v3/suppression/blocks/${email}`,
_19
method: 'GET',
_19
_19
}
_19
_19
client.request(request)
_19
.then(([response, body]) => {
_19
console.log(response.statusCode);
_19
console.log(response.body);
_19
})
_19
.catch(error => {
_19
console.error(error);
_19
});


Rate this page: