Skip to content

getcustomerlink.md

Latest commit

 

History

History
27 lines (22 loc) · 4.89 KB

getcustomerlink.md

File metadata and controls

27 lines (22 loc) · 4.89 KB

GetCustomerLink

Example Usage

import { GetCustomerLink } from "dub/models/operations";

let value: GetCustomerLink = {
  id: "<id>",
  domain: "gracious-draft.net",
  key: "<key>",
  shortLink: "https://speedy-cd.name",
  url: "https://sugary-programme.info/",
  programId: "<id>",
};

Fields

Field Type Required Description
id string ✔️ The unique ID of the short link.
domain string ✔️ The domain of the short link. If not provided, the primary domain for the workspace will be used (or dub.sh if the workspace has no domains).
key string ✔️ The short link slug. If not provided, a random 7-character slug will be generated.
shortLink string ✔️ The full URL of the short link, including the https protocol (e.g. https://dub.sh/try).
url string ✔️ The destination URL of the short link.
programId string ✔️ The ID of the program the short link is associated with.