API Reference

Email Security

Settings

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Content Policies

List content policies

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

Get a content policy

GET/accounts/{account_id}/email-security/settings/content_policies/{policy_id}

Create a content policy

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

Update a content policy

PATCH/accounts/{account_id}/email-security/settings/content_policies/{policy_id}

Delete a content policy

DELETE/accounts/{account_id}/email-security/settings/content_policies/{policy_id}

Batch content policy operations

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

ModelsExpand Collapse

ContentPolicyListResponse object { id, created_at, enabled, 5 more }

A content policy pattern that matches against the subject or body of an email.

id: optional string

Content policy identifier.

formatuuid

created_at: optional string

formatdate-time

enabled: optional boolean

Whether the policy is active.

modified_at: optional string

formatdate-time

name: optional string

Human-readable name of the policy.

maxLength256

minLength1

notes: optional string

Optional note describing the purpose of the policy.

maxLength4096

pattern: optional string

Regular expression the policy matches against.

maxLength2048

minLength1

targets: optional array of "SUBJECT" or "BODY"

Parts of the email the pattern is matched against.

One of the following:

"SUBJECT"

"BODY"

ContentPolicyGetResponse object { id, created_at, enabled, 5 more }

A content policy pattern that matches against the subject or body of an email.

id: optional string

Content policy identifier.

formatuuid

created_at: optional string

formatdate-time

enabled: optional boolean

Whether the policy is active.

modified_at: optional string

formatdate-time

name: optional string

Human-readable name of the policy.

maxLength256

minLength1

notes: optional string

Optional note describing the purpose of the policy.

maxLength4096

pattern: optional string

Regular expression the policy matches against.

maxLength2048

minLength1

targets: optional array of "SUBJECT" or "BODY"

Parts of the email the pattern is matched against.

One of the following:

"SUBJECT"

"BODY"

ContentPolicyCreateResponse object { id, created_at, enabled, 5 more }

A content policy pattern that matches against the subject or body of an email.

id: optional string

Content policy identifier.

formatuuid

created_at: optional string

formatdate-time

enabled: optional boolean

Whether the policy is active.

modified_at: optional string

formatdate-time

name: optional string

Human-readable name of the policy.

maxLength256

minLength1

notes: optional string

Optional note describing the purpose of the policy.

maxLength4096

pattern: optional string

Regular expression the policy matches against.

maxLength2048

minLength1

targets: optional array of "SUBJECT" or "BODY"

Parts of the email the pattern is matched against.

One of the following:

"SUBJECT"

"BODY"

ContentPolicyEditResponse object { id, created_at, enabled, 5 more }

A content policy pattern that matches against the subject or body of an email.

id: optional string

Content policy identifier.

formatuuid

created_at: optional string

formatdate-time

enabled: optional boolean

Whether the policy is active.

modified_at: optional string

formatdate-time

name: optional string

Human-readable name of the policy.

maxLength256

minLength1

notes: optional string

Optional note describing the purpose of the policy.

maxLength4096

pattern: optional string

Regular expression the policy matches against.

maxLength2048

minLength1

targets: optional array of "SUBJECT" or "BODY"

Parts of the email the pattern is matched against.

One of the following:

"SUBJECT"

"BODY"

ContentPolicyDeleteResponse object { id }

id: string

Content policy identifier.

formatuuid

ContentPolicyBatchResponse object { deletes, patches, posts, puts }

deletes: optional array of object { id }

id: string

Content policy identifier.

formatuuid

patches: optional array of object { id, created_at, enabled, 5 more }

id: optional string

Content policy identifier.

formatuuid

created_at: optional string

formatdate-time

enabled: optional boolean

Whether the policy is active.

modified_at: optional string

formatdate-time

name: optional string

Human-readable name of the policy.

maxLength256

minLength1

notes: optional string

Optional note describing the purpose of the policy.

maxLength4096

pattern: optional string

Regular expression the policy matches against.

maxLength2048

minLength1

targets: optional array of "SUBJECT" or "BODY"

Parts of the email the pattern is matched against.

One of the following:

"SUBJECT"

"BODY"

posts: optional array of object { id, created_at, enabled, 5 more }

id: optional string

Content policy identifier.

formatuuid

created_at: optional string

formatdate-time

enabled: optional boolean

Whether the policy is active.

modified_at: optional string

formatdate-time

name: optional string

Human-readable name of the policy.

maxLength256

minLength1

notes: optional string

Optional note describing the purpose of the policy.

maxLength4096

pattern: optional string

Regular expression the policy matches against.

maxLength2048

minLength1

targets: optional array of "SUBJECT" or "BODY"

Parts of the email the pattern is matched against.

One of the following:

"SUBJECT"

"BODY"

puts: optional array of object { id, created_at, enabled, 5 more }

id: optional string

Content policy identifier.

formatuuid

created_at: optional string

formatdate-time

enabled: optional boolean

Whether the policy is active.

modified_at: optional string

formatdate-time

name: optional string

Human-readable name of the policy.

maxLength256

minLength1

notes: optional string

Optional note describing the purpose of the policy.

maxLength4096

pattern: optional string

Regular expression the policy matches against.

maxLength2048

minLength1

targets: optional array of "SUBJECT" or "BODY"

Parts of the email the pattern is matched against.

One of the following:

"SUBJECT"

"BODY"