Skip to main content
POST
Set the default domain

Authorizations

Authorization
string
header
required

Workspace API key, sent as Authorization: Bearer lk_live_….

Path Parameters

id
string<uuid>
required

Domain ID.

Response

The domain that is now the workspace default.

id
string<uuid>
domain
string
Example:

"go.acme.com"

verified
boolean

true once the CNAME record has been confirmed.

status
enum<string>

pending until the CNAME is verified, then active. No other value is used.

Available options:
pending,
active
Example:

"active"

enabled
boolean

false when a plan downgrade disabled the domain. Disabled domains do not serve links.

primary
boolean
canUpdate
boolean

false for system domains.

canDelete
boolean

false for system domains.

workspaceId
string<uuid> | null

null for shared system domains such as telzi.com.

createdById
string<uuid> | null
updatedById
string<uuid> | null
createdAt
string<date-time>
updatedAt
string<date-time>