Skip to content

Mail

mail_domain_update

Update tracking / TLS / return-path config for a domain

Tool

mail_domain_update

Update tracking / TLS / return-path config for a domain

Update tracking / TLS / return-path config for a domain

Behavior

HTTP
PATCH /mail/domains/:id

Arguments

NameTypeRequiredDescription
idstringDomain id
tlsstringTLS policy: opportunistic (default) or enforced
openTrackingbooleanEnable open tracking (1×1 pixel); off by default
clickTrackingbooleanEnable click tracking (link rewrite); off by default
trackingSubdomainstringHost used for the click-redirect and open-pixel

Response

FieldTypeAlwaysDescription
idstring
tlsstring
apexstring
modestring
namestring
activeboolean
regionstring
statusstring
recordsarray
createdAtstring
updatedAtstring
verifiedAtstring
instructionsarray
openTrackingboolean
bindingStatusstring
clickTrackingboolean
customReturnPathstring
trackingSubdomainstring
governanceDomainIdstring
governanceBindingIdstring
verificationStartedAtstring
lastVerificationCheckAtstring

Try it

Update tracking / TLS / return-path config for a domain.

When to use

Update tracking / TLS / return-path config for a domain

Example

Ask your agent something like this:

Update tracking / TLS / return-path config for a domain.

The agent will invoke mail_domain_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect