Check whether an address is blocked

Checks whether an email address is currently blocked and returns the matching block rule when one applies.

POST
/v1/email/blocks/check

Checks whether an email address is currently blocked and returns the matching block rule when one applies.

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

emailAddress*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/email/blocks/check" \  -H "Content-Type: application/json" \  -d '{    "emailAddress": "string"  }'
{  "isBlocked": true,  "blockingRule": {    "id": "string",    "blockType": "email",    "blockValue": "string",    "reason": "string",    "expiresAt": "string"  },  "reason": "string"}