Update a domain

PATCH/domains/{id}

Changes open and click tracking, the tracking subdomain, TLS policy, and the sending and receiving capabilities.

Authorization

apiKey

AuthorizationBearer <token>

A project API key: Authorization: Bearer s0_…

In: header

Path Parameters

id*string

Length1 <= length <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

open_tracking?boolean

click_tracking?boolean

tls?string

Value in

"opportunistic"
"enforced"

capabilities?

tracking_subdomain?|null

receiving_connection_id?string

Stamp0 con_ identifier

Match^con_[0-9A-Za-z]{16}$

receiving?

setup_token?string

Match^[A-Za-z0-9_.-]{20,512}$

confirm_mx_takeover?boolean

confirm_dmarc_create?boolean

keep_email_preview?boolean

Response Body

`application/json`

curl -X PATCH "https://example.com/domains/string" \  -H "Content-Type: application/json" \  -d '{}'

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

Update a domain

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

501application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`