Skip to main content
PATCH
Update a domain

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The domain's ID.

Body

application/json
site_id
string | null
page
string | null

Slug of a public published page to serve at this hostname; null stops serving it. A gated page can't be served on a custom domain, and a hostname serves either a site or one page.

pages
boolean

true makes this the account's pages domain (every published page at https:///, gated ones after the viewer signs in on it); false stops it.

capabilities
object

Response

Domain

object
string
required
id
string
required
domain
string
required
purchase_status
enum<string> | null
required
Available options:
pending_payment,
registering,
registered,
failed,
null
site_id
object
required
page
string | null
required
pages
boolean
required

True when the domain serves every published page of the account at https:///.

managed_zone
boolean
required
zone_id
object
required
capabilities
object
required
records
object
required
next_step
object
required
created_at
string<date-time>
required
verification_errors
string[]
required
verified_at
string<date-time> | null