API Reference

Email Security

Settings

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Trusted Domains

List trusted email domains

client.emailSecurity.settings.trustedDomains.list(TrustedDomainListParams { account_id, direction, is_recent, 6 more } params, RequestOptionsoptions?): V4PagePaginationArray<TrustedDomainListResponse { id, comments, created_at, 6 more } >

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

Get a trusted email domain

client.emailSecurity.settings.trustedDomains.get(stringtrustedDomainId, TrustedDomainGetParams { account_id } params, RequestOptionsoptions?): TrustedDomainGetResponse { id, comments, created_at, 6 more }

GET/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Create trusted email domain

client.emailSecurity.settings.trustedDomains.create(TrustedDomainCreateParams { account_id, is_recent, is_regex, 3 more } params, RequestOptionsoptions?): TrustedDomainCreateResponse { id, comments, created_at, 6 more }

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

Update a trusted email domain

client.emailSecurity.settings.trustedDomains.edit(stringtrustedDomainId, TrustedDomainEditParams { account_id, comments, is_recent, 3 more } params, RequestOptionsoptions?): TrustedDomainEditResponse { id, comments, created_at, 6 more }

PATCH/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Delete a trusted email domain

client.emailSecurity.settings.trustedDomains.delete(stringtrustedDomainId, TrustedDomainDeleteParams { account_id } params, RequestOptionsoptions?): TrustedDomainDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

ModelsExpand Collapse

TrustedDomainListResponse { id, comments, created_at, 6 more }

A trusted email domain

id?: string

Trusted domain identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_recent?: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex?: boolean

is_similarity?: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified?: string

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

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

TrustedDomainGetResponse { id, comments, created_at, 6 more }

A trusted email domain

id?: string

Trusted domain identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_recent?: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex?: boolean

is_similarity?: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified?: string

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

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

TrustedDomainCreateResponse { id, comments, created_at, 6 more }

A trusted email domain

id?: string

Trusted domain identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_recent?: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex?: boolean

is_similarity?: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified?: string

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

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

TrustedDomainEditResponse { id, comments, created_at, 6 more }

A trusted email domain

id?: string

Trusted domain identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_recent?: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex?: boolean

is_similarity?: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified?: string

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

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

TrustedDomainDeleteResponse { id }

id: string

Trusted domain identifier

formatuuid