PATCH
/domains/{domain_id}Update a domain
Updates the configuration of an existing domain. Supply only the settings you want to change, such as tracking options, TLS mode, capabilities, or the tracking subdomain.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
domain_idstringrequired
The identifier of the domain to update.
The domain settings to update.
open_trackingbooleanoptional
Track the open rate of each email.
click_trackingbooleanoptional
Track clicks within the body of each HTML email.
tlsstringoptional
enforced | opportunistic.
capabilitiesobjectoptional
Configure the domain capabilities for sending and receiving emails. At least one capability must be enabled.
tracking_subdomainstringoptional
The subdomain to use for click and open tracking.
200Returns the updated domain's identifier and object type.
idstringoptional
The ID of the updated domain.
objectstringoptional
The object type representing the updated domain.
Error handling
The domain_id path parameter must identify an existing domain. tls must be opportunistic or enforced, and at least one capability must be enabled in capabilities.