Domains

Update a domain

Update a domain's sending options: open/click tracking defaults, TLS enforcement, and the tracking subdomain. These act as the domain-level defaults that individual emails and campaigns can override (see Update a campaign). A tracking_subdomain can be set at any time, so you can publish its CNAME along with the domain's other records. It is only checked once the domain is verified, and tracked links switch to it once its CNAME is published and it answers over HTTPS; until then they use the default tracking host. After a change, links keep using the previous subdomain until the new one answers over HTTPS (keep the previous CNAME in place). Changing it is limited to a few times an hour per domain, and to a few new subdomains a day per workspace. Requires the domains:write capability.

patch/email/domains/{id}

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/email/domains/{id}
  • Auth: HTTP bearer

Request body

open_trackingboolean nullable
click_trackingboolean nullable
tls'opportunistic' | 'enforced'
tracking_subdomainstring nullable

Response

The updated domain.

object'domain' required
idstring required
namestring required
status'pending' | 'verifying' | 'verified' | 'degraded' | 'failed' required
dkim_selectorstring nullable required
open_trackingboolean nullable required
click_trackingboolean nullable required
tls'opportunistic' | 'enforced' required
tracking_subdomainstring nullable required
tracking_verified_atstring nullable required

When tracked links and open pixels started using the custom tracking host (tracking_subdomain). Non-null only while sends actually use it: the domain is verified (or degraded) and the host's last check proved it answers over HTTPS. Otherwise null, and links use the default tracking host. A host that stops answering, or a domain that's no longer verified, goes back to null.

verified_atstring nullable required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.