Site Domain

Connect a custom domain

Subdomains (news.acme.com) need one CNAME. Naked domains (acme.com) also get a TXT record for the security certificate and need ALIAS/flattened-CNAME support at the DNS provider; set www_enabled to serve www too.

post/lists/{listId}/site-domain

Request

  • Base URL: https://api.tinysend.com/v1
  • URL: https://api.tinysend.com/v1/lists/{listId}/site-domain
  • Auth: HTTP bearer

Path parameters

listIdstring required

Request body

domainstring required

domain or subdomain you own

www_enabledboolean

also serve www.<domain> (for naked domains)

Example request

{
  "domain": "news.acme.com"
}

Response

Domain added, records returned

domainstring nullable required
default_urlstring required
live_urlstring nullable required
status'not_configured' | 'pending' | 'active' | 'failed' required
next_stepstring required

plain-language description of what happens next / what the user needs to do

Changes

No recorded changes to this operation across all 1 revision of this API.