Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
Email

Complete an automatic Custom Tracking Domain return

Validates the signed state returned by the DNS provider, then checks the tracking host again.

POST
/v1/email/domains/{id}/custom-tracking/domain-connect/complete

Validates the signed state returned by the DNS provider, then checks the tracking host again. Returning here never marks the host ready or changes which tracking host email uses.

Authorization

apiKey
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.

state*string
error?string|null
errorDescription?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/email/domains/string/custom-tracking/domain-connect/complete" \  -H "Content-Type: application/json" \  -d '{    "state": "string"  }'
{  "status": "applied"}

Related documentation

Clear a domain's default sender

Removes the domain's default sender so omitted-`from` sends fall through to the organization default sender.

Complete a one-click DNS return

Consumes the Domain Connect provider's redirect. Validates the signed state and, when the DNS provider reports success, starts checking the domain's records.