Branded domains

Branded domains allow you to create your custom link shortener.
You can list all the domains you own, and choose the one that best fits your branded short links.

Example Domain Object
{
    "id": "4d20ec31db1e48c5aded19e93f137a11",
    "fullName": "brand.cool",
    "topLevelDomain": "cool",
    "createdAt": "2016-07-01T13:12:22.000Z",
    "updatedAt": "2016-07-03T13:17:50.000Z",
    "type": "user",
    "active": false
  }

DOMAIN OBJECT

Main properties of a Domain object are:

Property

Type

Description

id

string

Unique identifier for the branded domain

fullName

string

Full name of the branded domain

topLevelDomain

string

The top level domain part of the branded domain name

createdAt

timestamp

UTC creation date/time of the branded domain

updatedAt

timestamp

UTC last update date/time of the branded domain

type

string enum

  • service
  • user

Branded domain type

active

boolean

Whether the branded domain can be used or not to create branded short links

Deprecated properties

🚧

WARNING

We will continue to render deprecated Domain properties for backward compatibility in v1

Deprecated properties you can find in a Domain object are:

Property

Type

Description

Reason

creationDate

timestamp

UTC creation date/time of the branded domain

Now using createdAt

Branded domains management

Here are some basic operations you perform regarding Domain resources:

Operation

Details

Access your branded domains collection

See Getting domain details


Did this page help you?