Menu

Expand
Rate this page:

Blocks API

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.

Retrieve all blocks

GET /v3/suppression/blocks

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

This endpoint allows you to retrieve all email addresses that are currently on your blocks list. A maximum of 500 blocks will be returned per query. You can use the offset and limit parameters to retrieve more or less than 500 results.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string

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.

default: None

Query String

start_time
integer

The start of the time range when a blocked email was created (inclusive). This is a unix timestamp.

default: None
end_time
integer

The end of the time range when a blocked email was created (inclusive). This is a unix timestamp.

default: None
limit
integer

Limit the number of results to be displayed per page.

default: None
offset
integer

The point in the list to begin displaying results. To retrieve more than 500 results, you can make multiple requests to the API, using the offset to begin at the next result in the list.

default: None

Responses

array[object]
created
integer

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

required
email
string

The email address that was added to the block list.

format: email
required
reason
string

An explanation for the reason of the block.

required
status
string

The status of the block.

required
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  }
]
Loading Code Sample...
        
        

        Retrieve all blocks

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif