Skip to main content

​
Authentication

This endpoint requires authentication using a Bearer token. 
curl -X PATCH https://api.dub.co/domains/acme.com \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "archived": false,
    "placeholder": "https://dub.co/help/article/updated"
  }'

​
Path Parameters

​
slug
string
required
The domain name to update.Example: acme.com

​
Request Body

All fields are optional. Only include the fields you want to update.
​
slug
string
Name of the domain.Example: acme.com
​
expiredUrl
string
Redirect users to a specific URL when any link under this domain has expired.Example: https://acme.com/expired
​
notFoundUrl
string
Redirect users to a specific URL when a link under this domain doesn’t exist.Example: https://acme.com/not-found
​
placeholder
string
Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.Example: https://dub.co/help/article/dub-linksMaximum length: 100 characters
​
archived
boolean
Whether to archive this domain. false will unarchive a previously archived domain.
The logo of the domain (uploaded image URL).
​
assetLinks
string
assetLinks.json configuration file (for deep link support on Android).
​
appleAppSiteAssociation
string
apple-app-site-association configuration file (for deep link support on iOS).

​
Response

​
id
string
The unique identifier of the domain.
​
slug
string
The domain name.Example: acme.com
​
verified
boolean
Whether the domain is verified.
​
primary
boolean
Whether the domain is the primary domain for the workspace.
​
archived
boolean
Whether the domain is archived.
​
placeholder
string | null
Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.
​
expiredUrl
string | null
The URL to redirect to when a link under this domain has expired.
​
notFoundUrl
string | null
The URL to redirect to when a link under this domain doesn’t exist.
​
logo
string | null
The logo of the domain.
​
assetLinks
string | null
assetLinks.json configuration file (for deep link support on Android).
​
appleAppSiteAssociation
string | null
apple-app-site-association configuration file (for deep link support on iOS).
​
createdAt
date
The date the domain was created.
​
updatedAt
date
The date the domain was last updated.
​
registeredDomain
object | null
The registered domain record.
​
id
string
The ID of the registered domain record.
​
autoRenewalDisabledAt
date | null
The date the domain auto-renew is disabled.
​
createdAt
date
The date the domain was created.
​
expiresAt
date
The date the domain expires.
​
renewalFee
number
The fee to renew the domain.
{
  "id": "dom_abc123",
  "slug": "acme.com",
  "verified": true,
  "primary": true,
  "archived": false,
  "placeholder": "https://dub.co/help/article/updated",
  "expiredUrl": "https://acme.com/expired",
  "notFoundUrl": "https://acme.com/not-found",
  "logo": null,
  "assetLinks": null,
  "appleAppSiteAssociation": null,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-15T12:30:00.000Z",
  "registeredDomain": null
}

Build docs developers (and LLMs) love

Get started for freeTalk to us