Skip to main content
POST
/
domains
Python
from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.domains.create(request={
        "slug": "acme.com",
        "expired_url": "https://acme.com/expired",
        "not_found_url": "https://acme.com/not-found",
        "placeholder": "https://dub.co/help/article/what-is-dub",
    })

    assert res is not None

    # Handle response
    print(res)
{
  "id": "<string>",
  "slug": "acme.com",
  "verified": false,
  "primary": false,
  "archived": false,
  "placeholder": "https://dub.co/help/article/what-is-dub",
  "expiredUrl": "https://acme.com/expired",
  "notFoundUrl": "https://acme.com/not-found",
  "logo": "<string>",
  "assetLinks": null,
  "appleAppSiteAssociation": null,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "registeredDomain": {
    "id": "<string>",
    "autoRenewalDisabledAt": "<string>",
    "createdAt": "<string>",
    "expiresAt": "<string>",
    "renewalFee": 123
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Body

application/json
​
slug
string
required

Name of the domain.

Required string length: 1 - 190
Example:

"acme.com"

​
expiredUrl
string | null

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

Maximum length: 32000
Example:

"https://acme.com/expired"

​
notFoundUrl
string | null

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

Maximum length: 32000
Example:

"https://acme.com/not-found"

​
archived
boolean
default:false

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

Example:

false

​
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
Example:

"https://dub.co/help/article/what-is-dub"

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).

Response

The domain was created.

​
id
string
required

The unique identifier of the domain.

​
slug
string
required

The domain name.

Example:

"acme.com"

​
verified
boolean
default:false
required

Whether the domain is verified.

​
primary
boolean
default:false
required

Whether the domain is the primary domain for the workspace.

​
archived
boolean
default:false
required

Whether the domain is archived.

​
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.

Example:

"https://dub.co/help/article/what-is-dub"

​
expiredUrl
string | null
required

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

Example:

"https://acme.com/expired"

​
notFoundUrl
string | null
required

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

Example:

"https://acme.com/not-found"

The logo of the domain.

​
assetLinks
string | null
required

assetLinks.json configuration file (for deep link support on Android).

​
appleAppSiteAssociation
string | null
required

apple-app-site-association configuration file (for deep link support on iOS).

​
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.

⌘I