Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
domain
string
required

The domain to connect (e.g. shop.example.com).

site
string

Prefix id of the site to attach the domain to. Defaults to the account's site.

setup_email
boolean

Also configure outbound email on this domain.

Response

Domain connected (pending verification)

object
string
required
id
string
required
domain
string
required
status
enum<string> | null
required
Available options:
pending,
ssl_pending,
active,
error,
null
dns_status
string | null
required
verified
boolean
required
managed
boolean
required
verified_at
string | null
required
site_id
string | null
required
cname_target
string
required
dns_records
object
required
verification_errors
string[]
required
created_at
string
required