Arguments

slug
string

Name of the domain. If provided, the existing domain will be updated with the new domain. Eg. acme.com.

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.

archived
boolean
default: false

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

placeholder
string | null
default: "https://dub.co/help/article/what-is-dub"

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

Response

id
string
required

The unique identifier of the domain.

slug
string
required

The domain name.

verified
boolean
default: falserequired

Whether the domain is verified.

primary
boolean
default: falserequired

Whether the domain is the primary domain for the workspace.

archived
boolean
default: falserequired

Whether the domain is archived.

placeholder
string
default: "https://dub.co/help/article/what-is-dub"required

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

expiredUrl
string | null
required

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

notFoundUrl
string | null
required

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

createdAt
string
required

The date the domain was created.

updatedAt
string
required

The date the domain was last updated.

registeredDomain
object | null
required

The registered domain record.