Skip to content

Latest commit

 

History

History
42 lines (37 loc) · 9.67 KB

domainschema.md

File metadata and controls

42 lines (37 loc) · 9.67 KB

DomainSchema

Example Usage

import { DomainSchema } from "dub/models/components";

let value: DomainSchema = {
  id: "<id>",
  slug: "acme.com",
  placeholder: "https://dub.co/help/article/what-is-dub",
  expiredUrl: "https://acme.com/expired",
  notFoundUrl: "https://acme.com/not-found",
  logo: "<value>",
  createdAt: "1741979001618",
  updatedAt: "1743279521303",
  registeredDomain: {
    id: "<id>",
    createdAt: "1730924451796",
    expiresAt: "1758676849165",
  },
};

Fields

Field Type Required Description Example
id string ✔️ The unique identifier of the domain.
slug string ✔️ The domain name. 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 ✔️ Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened. https://dub.co/help/article/what-is-dub
expiredUrl string ✔️ The URL to redirect to when a link under this domain has expired. https://acme.com/expired
notFoundUrl string ✔️ The URL to redirect to when a link under this domain doesn't exist. https://acme.com/not-found
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).
logo string ✔️ The logo of the domain.
createdAt string ✔️ The date the domain was created.
updatedAt string ✔️ The date the domain was last updated.
registeredDomain components.RegisteredDomain ✔️ The registered domain record.