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

Send a Batch of Allow Policies API calls to be executed together.

Servers

Path parameters

Name Type Required Description
account_id String Yes

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
posts[] Array Yes
posts[].is_recipient Boolean No
posts[].is_exempt_recipient Boolean Yes

Messages to this recipient will bypass all detections.

posts[].pattern_type String Yes

Valid values:

  • "EMAIL"
  • "DOMAIN"
  • "UNKNOWN"
  • "IP"
posts[].is_spoof Boolean No
posts[].verify_sender Boolean Yes

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

posts[].is_sender Boolean No
posts[].is_trusted_sender Boolean Yes

Messages from this sender will bypass all detections and link following.

posts[].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.

posts[].is_regex Boolean Yes
posts[].pattern String Yes
posts[].comments String No
deletes[] Array Yes
deletes[].id Integer Yes

The unique identifier for the allow policy.

patches[] Array Yes
patches[].id Integer Yes

The unique identifier for the allow policy.

patches[].is_exempt_recipient Boolean No

Messages to this recipient will bypass all detections.

patches[].pattern_type String No

Valid values:

  • "EMAIL"
  • "DOMAIN"
  • "UNKNOWN"
  • "IP"
patches[].verify_sender Boolean No

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

patches[].is_trusted_sender Boolean No

Messages from this sender will bypass all detections and link following.

patches[].is_acceptable_sender Boolean No

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

patches[].is_regex Boolean No
patches[].pattern String No
patches[].comments String No
puts[] Array Yes
puts[].id Integer Yes

The unique identifier for the allow policy.

puts[].is_recipient Boolean No
puts[].is_exempt_recipient Boolean Yes

Messages to this recipient will bypass all detections.

puts[].pattern_type String Yes

Valid values:

  • "EMAIL"
  • "DOMAIN"
  • "UNKNOWN"
  • "IP"
puts[].is_spoof Boolean No
puts[].verify_sender Boolean Yes

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

puts[].is_sender Boolean No
puts[].is_trusted_sender Boolean Yes

Messages from this sender will bypass all detections and link following.

puts[].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.

puts[].is_regex Boolean Yes
puts[].pattern String Yes
puts[].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.