Domains

Update domain tracking and TLS preferences

patch/domains/{id}

Request

  • Base URL: https://api.supersendtx.com
  • URL: https://api.supersendtx.com/domains/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Domain id or domain name

Request body

open_trackingboolean
openTrackingboolean

Alias for open_tracking

click_trackingboolean
clickTrackingboolean

Alias for click_tracking

tls_mode'opportunistic' | 'enforced'
tlsMode'opportunistic' | 'enforced'

Alias for tls_mode

inbound_enabledboolean

Enable or disable inbound receiving for this domain.

inboundEnabledboolean

Alias for inbound_enabled

Response

Domain settings updated

inbound_notestring required
inbound_configuredboolean
inbound_pendingboolean
inbound_errorstring nullable
tracking_errorstring nullable

Present when tracking preferences were saved but delivery-side tracking provisioning failed. Customer-facing message; internal failure details are logged server-side.

tls_errorstring nullable

Present when TLS mode was saved but delivery-side TLS provisioning failed. Customer-facing message; internal failure details are logged server-side.

Example response

{
  "domain": {
    "name": "example.com"
  },
  "records": [
    {
      "type": "TXT"
    }
  ],
  "inbound_records": [
    {
      "type": "TXT"
    }
  ]
}

Changes

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