API · Domains

Update Domain

Update tracking, TLS, or receiving settings for a domain that has completed setup (requires full access). Omitted or null settings stay unchanged; receiving requires a supported region.

PATCH/domains/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Opaque resource id.
`open_tracking` body · optional	`boolean \| null`	Enable open tracking over HTTP; HTTPS tracking requires a CDN and certificate configured by your operator.
`click_tracking` body · optional	`boolean \| null`	Enable click tracking over HTTP; HTTPS tracking requires a CDN and certificate configured by your operator.
`tracking_subdomain` body · optional	`string \| null`	Tracking subdomain activated after CNAME verification, which can be changed but cannot be removed.
`tls` body · optional	`"opportunistic" \| "enforced" \| null`	enforced \| opportunistic.
`capabilities` body · optional	`object`	Choose sending and receiving capabilities with at least one enabled.
`capabilities.sending` body · optional	`"enabled" \| "disabled" \| null`	Enable or disable sending emails from this domain.
`capabilities.receiving` body · optional	`"enabled" \| "disabled" \| null`	Enable or disable receiving emails to this domain.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X PATCH "$OPENSEND_BASE_URL/domains/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"open_tracking":true}'

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "domain",
  "id": "YOUR_ID"
}

Behavior and errors

Provision the domain before changing capabilities or TLS. Region and name are not mutable through this endpoint. Tracking uses HTTP redirects after CNAME verification. HTTPS requires separate operator-managed routing and certificates.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.