API Reference

Email Security

Settings

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Block Senders

List blocked email senders

GET/accounts/{account_id}/email-security/settings/block_senders

Get a blocked email sender

GET/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Create a blocked email sender

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

Update a blocked email sender

PATCH/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Delete a blocked email sender

DELETE/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

ModelsExpand Collapse

BlockSenderListResponse object { id, created_at, is_regex, 4 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_regex: boolean

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" or "DOMAIN" or "IP" or "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

comments: optional string

maxLength1024

BlockSenderGetResponse object { id, created_at, is_regex, 4 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_regex: boolean

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" or "DOMAIN" or "IP" or "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

comments: optional string

maxLength1024

BlockSenderCreateResponse object { id, created_at, is_regex, 4 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_regex: boolean

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" or "DOMAIN" or "IP" or "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

comments: optional string

maxLength1024

BlockSenderEditResponse object { id, created_at, is_regex, 4 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_regex: boolean

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" or "DOMAIN" or "IP" or "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

comments: optional string

maxLength1024

BlockSenderDeleteResponse object { id }

id: number

The unique identifier for the allow policy.

formatint32