POST /accounts/{account_id}/email-security/settings/allow_policies

Creates a new allow policy that exempts matching emails from security detections. Use with caution as this bypasses email security scanning. Policies can match on sender patterns and apply to specific detections or all detections.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Account identifier tag.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
is_recipient Boolean No

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_exempt_recipient Boolean Yes

Messages to this recipient will bypass all detections

is_spoof Boolean No

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

verify_sender Boolean Yes

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

last_modified String Yes

Deprecated, use modified_at instead. End of life: November 1, 2026.

modified_at String No
id String Yes

Allow policy identifier

pattern_type String Yes

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

Valid values:

  • "EMAIL"
  • "DOMAIN"
  • "UNKNOWN"
  • "IP"
is_sender Boolean No

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

is_trusted_sender Boolean Yes

Messages from this sender will bypass all detections and link following

is_acceptable_sender Boolean Yes

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions.

created_at String Yes
is_regex Boolean Yes
pattern String Yes
comments String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.