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

Execute multiple operations atomically. All four operation arrays (deletes, patches, puts, posts) are required and executed in order. Send empty arrays for unused operations.

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
posts[] Array Yes
posts[].id String No

Blocked sender pattern identifier

posts[].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"
posts[].last_modified String No

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

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

Blocked sender pattern identifier

patches[] Array Yes
patches[].id String Yes

Blocked sender pattern identifier

patches[].pattern_type String No

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"
patches[].last_modified String No

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

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

Blocked sender pattern identifier

puts[].pattern_type String No

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"
puts[].last_modified String No

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

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