API Reference

Email Security

Settings

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sending Domain Restrictions

List sending domain restrictions

client.emailSecurity.settings.sendingDomainRestrictions.list(SendingDomainRestrictionListParams { account_id, direction, order, 3 more } params, RequestOptionsoptions?): V4PagePaginationArray<SendingDomainRestrictionListResponse { id, comments, created_at, 4 more } >

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

Get a sending domain restriction

client.emailSecurity.settings.sendingDomainRestrictions.get(stringsendingDomainRestrictionID, SendingDomainRestrictionGetParams { account_id } params, RequestOptionsoptions?): SendingDomainRestrictionGetResponse { id, comments, created_at, 4 more }

GET/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}

Create a sending domain restriction

client.emailSecurity.settings.sendingDomainRestrictions.create(SendingDomainRestrictionCreateParams { account_id, domain, exclude, comments } params, RequestOptionsoptions?): SendingDomainRestrictionCreateResponse { id, comments, created_at, 4 more }

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

Update a sending domain restriction

client.emailSecurity.settings.sendingDomainRestrictions.edit(stringsendingDomainRestrictionID, SendingDomainRestrictionEditParams { account_id, comments, domain, exclude } params, RequestOptionsoptions?): SendingDomainRestrictionEditResponse { id, comments, created_at, 4 more }

PATCH/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}

Delete a sending domain restriction

client.emailSecurity.settings.sendingDomainRestrictions.delete(stringsendingDomainRestrictionID, SendingDomainRestrictionDeleteParams { account_id } params, RequestOptionsoptions?): SendingDomainRestrictionDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}

ModelsExpand Collapse

SendingDomainRestrictionListResponse { id, comments, created_at, 4 more }

A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, the system drops mail without TLS from the specified domain.

id?: string

Sending domain restriction identifier.

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

domain?: string

Domain that requires TLS enforcement.

exclude?: Array<string>

Subdomains to exempt from TLS requirements.

Deprecatedlast_modified?: string

Use modified_at instead.

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

formatdate-time

modified_at?: string

formatdate-time

SendingDomainRestrictionGetResponse { id, comments, created_at, 4 more }

A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, the system drops mail without TLS from the specified domain.

id?: string

Sending domain restriction identifier.

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

domain?: string

Domain that requires TLS enforcement.

exclude?: Array<string>

Subdomains to exempt from TLS requirements.

Deprecatedlast_modified?: string

Use modified_at instead.

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

formatdate-time

modified_at?: string

formatdate-time

SendingDomainRestrictionCreateResponse { id, comments, created_at, 4 more }

A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, the system drops mail without TLS from the specified domain.

id?: string

Sending domain restriction identifier.

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

domain?: string

Domain that requires TLS enforcement.

exclude?: Array<string>

Subdomains to exempt from TLS requirements.

Deprecatedlast_modified?: string

Use modified_at instead.

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

formatdate-time

modified_at?: string

formatdate-time

SendingDomainRestrictionEditResponse { id, comments, created_at, 4 more }

A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, the system drops mail without TLS from the specified domain.

id?: string

Sending domain restriction identifier.

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

domain?: string

Domain that requires TLS enforcement.

exclude?: Array<string>

Subdomains to exempt from TLS requirements.

Deprecatedlast_modified?: string

Use modified_at instead.

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

formatdate-time

modified_at?: string

formatdate-time

SendingDomainRestrictionDeleteResponse { id }

id: string

Sending domain restriction identifier.

formatuuid