Create a domain

Create a domain for the authenticated workspace.

Authorizations

Authorization

string

header

required

Default authentication mechanism

Body

application/json

slug

string

required

Name of the domain.

Required string length: 1 - 190

archived

boolean

default:

false

Whether to archive this domain. false will unarchive a previously archived domain.

expiredUrl

string | null

Redirect users to a specific URL when any link under this domain has expired.

notFoundUrl

string | null

Redirect users to a specific URL when a link under this domain doesn't exist.

placeholder

string | null

Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.

Maximum length: 100

Response

201 - application/json

archived

boolean

default:

false

required

Whether the domain is archived.

createdAt

string

required

The date the domain was created.

expiredUrl

string | null

required

The URL to redirect to when a link under this domain has expired.

id

string

required

The unique identifier of the domain.

notFoundUrl

string | null

required

The URL to redirect to when a link under this domain doesn't exist.

placeholder

string | null

required

Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.

primary

boolean

default:

false

required

Whether the domain is the primary domain for the workspace.

registeredDomain

object | null

required

The registered domain record.

Show child attributes

registeredDomain.createdAt

string

required

The date the domain was created.

registeredDomain.expiresAt

string

required

The date the domain expires.

registeredDomain.id

string

required

The ID of the registered domain record.

slug

string

required

The domain name.

updatedAt

string

required

The date the domain was last updated.

verified

boolean

default:

false

required

Whether the domain is verified.