Skip to Content

Update a domain's send-settings config

Overrides the domain's open/click tracking, reply-to, topic defaults, and the brand its mail uses for the settings cascade.

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

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

Authorization

apiKey
headerx-api-key<token>

Path Parameters

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

Request Body

application/json
  1. body
shared?boolean|null
openTracking?boolean|null|null
clickTracking?boolean|null|null
replyTo?array<>|null|null
topicId?|null|null
footerEnabled?boolean|null|null
brandSlug?|null|null

Response Body

Success

application/json
  1. response
id*EmailDomainId
Match^dom_[0-9a-hjkmnp-tv-z]{16,24}$
shared*boolean
openTracking*boolean|null
clickTracking*boolean|null
replyTo*array<string>|null
topicId*|null
footerEnabled*boolean|null
brandSlug*|null
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.email.updateDomainConfig({
  "id": "example"
});
Example Response
{
  "id": "string",
  "shared": true,
  "openTracking": true,
  "clickTracking": true,
  "replyTo": [
    "string"
  ],
  "topicId": "string",
  "footerEnabled": true,
  "brandSlug": "string"
}

Related documentation