Update a domain's send-settings config

Overrides the domain's open/click tracking, reply-to, and unsubscribe-group defaults for the settings cascade.

PATCH
/v1/email/domains/{id}/config

Overrides the domain's open/click tracking, reply-to, and unsubscribe-group defaults for the settings cascade. An omitted field is left unchanged; null clears it back to the organization default. Returns the saved config.

x-api-key<token>

In: header

Path Parameters

id*string
Match^dom_[0-9a-hjkmnp-tv-z]{16,24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

openTracking?boolean|null|null
clickTracking?boolean|null|null
replyTo?array<string>|null|null
unsubscribeGroupId?|null|null
footerEnabled?boolean|null|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/email/domains/string/config" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "openTracking": true,  "clickTracking": true,  "replyTo": [    "string"  ],  "unsubscribeGroupId": "string",  "footerEnabled": true}