Skip to main content
POST
Create a custom domain

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the business

Body

application/json
domain
string
required

The domain name

Response

200 - application/json

The created CustomDomain object

id
string
required

The ID of the custom domain

business
string
required

The ID of the business

domain
string
required

The domain name

dns_records
object[] | null
required

The DNS records for the domain

created_at
string
required

The date and time the custom domain was created

validated
boolean
required

Whether the domain is valid

setup_completed_at
string | null
required

The date and time setup was completed

setup_type
string | null
required

The type of setup (automatic or manual)