Skip to main content
POST
/
api
/
e2
/
guard
/
{id}
/
check
Check if rule matches email
curl --request POST \
  --url https://inbound.new/api/e2/guard/{id}/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "structuredEmailId": "<string>"
}
'
{
  "matched": true,
  "matchDetails": [
    {
      "criteria": "<string>",
      "value": "<string>"
    }
  ],
  "reason": "<string>"
}

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

id
string
required

Body

structuredEmailId
string
required

ID of the email to test against the rule

Response

Response for status 200

matched
boolean
required
matchDetails
object[]
reason
string