v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB

Domains

Provision Stream Identity

Provision a transactional or marketing sending identity on a domain you own. Creates notify.<rootDomain> (transactional) or send.<rootDomain> (marketing) to isolate transactional reputation from marketing. Returns DNS records to publish, then verify. Requires API key with domain:write.

post/v1/domains/streams

Request body

rootDomainstring required

Apex domain you own (e.g., 'acme.com'). The stream subdomain is derived from it.

stream'transactional' | 'marketing' required

'transactional' provisions notify.<rootDomain>; 'marketing' provisions send.<rootDomain>.

vanityRootFromboolean

Show the apex domain in the From header when its DMARC passes.

Response

Stream identity provisioned. Publish the returned DNS records, then verify.

successboolean required

errorstring nullable