Domain

Configure custom tracking and bounce domains. Custom domains replace default platform URLs in email links and bounce handling with your own branded domains.

Show domains

GET

https://api.cakemail.dev

/brands/default/domains/default

Show the Tracking and Bounce domains.

Required scope(s): domains:read

Show domains › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show domains › Responses

Successful Response

DomainsResponse

DomainsFullResponse · required

Change domains

PATCH

https://api.cakemail.dev

/brands/default/domains/default

Change the Tracking and Bounce domains.

Required scope(s): domains:write

Change domains › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Change domains › Request Body

PatchDomains

object · required

Custom domain configuration

Change domains › Responses

Successful Response

PatchDomainsResponse

DomainsFullResponse · required

object

string

Default: domains

patched

boolean

Default: true

PATCH/brands/default/domains/default

curl https://api.cakemail.dev/brands/default/domains/default \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "domains": {
    "bounce": "bounce",
    "tracking": "https://www.example.com/path/to/resource",
    "forward": "https://www.example.com/path/to/resource"
  }
}'

Example Request Body

{
  "domains": {
    "bounce": "bounce",
    "tracking": "https://www.example.com/path/to/resource",
    "forward": "https://www.example.com/path/to/resource"
  }
}

json

Example Responses

{
  "object": "domains",
  "patched": true,
  "data": {
    "auth": "auth",
    "bounce": "bounce",
    "dkim": "dkim",
    "tracking": "tracking",
    "forward": "forward"
  }
}

json

application/json

Validate domains

GET

https://api.cakemail.dev

/brands/default/domains/default/validate

Validate and return the DNS entries for the Tracking and the Bounce domains.

Required scope(s): domains:read

Validate domains › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Validate domains › Responses

Successful Response

ValidateDomainsResponse

DomainsInstructionResponse · required

DKIM Suppressed Email