Skip to content

Latest commit

 

History

History
50 lines (45 loc) · 44.8 KB

createlinkrequestbody.md

File metadata and controls

50 lines (45 loc) · 44.8 KB

CreateLinkRequestBody

Example Usage

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

let value: CreateLinkRequestBody = {
  url: "https://google.com",
};

Fields

Field Type Required Description Example
url string ✔️ The destination URL of the short link. https://google.com
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.
externalId string The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. 123456
tenantId string The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
prefix string The prefix of the short link slug for randomly-generated keys (e.g. if prefix is /c/, generated keys will be in the /c/:key format). Will be ignored if key is provided.
trackConversion boolean Whether to track conversions for the short link. Defaults to false if not provided.
archived boolean Whether the short link is archived. Defaults to false if not provided.
publicStats boolean : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use dashboard instead. Whether the short link's stats are publicly accessible. Defaults to false if not provided.
tagId string : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The unique ID of the tag assigned to the short link. This field is deprecated – use tagIds instead.
tagIds operations.TagIds The unique IDs of the tags assigned to the short link. [
"clux0rgak00011..."
]
tagNames operations.TagNames The unique name of the tags assigned to the short link (case insensitive).
comments string The comments for the short link.
expiresAt string The date and time when the short link will expire at.
expiredUrl string The URL to redirect to when the short link has expired.
password string The password required to access the destination URL of the short link.
proxy boolean Whether the short link uses Custom Social Media Cards feature. Defaults to false if not provided.
title string The custom link preview title (og:title). Will be used for Custom Social Media Cards if proxy is true. Learn more: https://d.to/og
description string The custom link preview description (og:description). Will be used for Custom Social Media Cards if proxy is true. Learn more: https://d.to/og
image string The custom link preview image (og:image). Will be used for Custom Social Media Cards if proxy is true. Learn more: https://d.to/og
video string The custom link preview video (og:video). Will be used for Custom Social Media Cards if proxy is true. Learn more: https://d.to/og
rewrite boolean Whether the short link uses link cloaking. Defaults to false if not provided.
ios string The iOS destination URL for the short link for iOS device targeting.
android string The Android destination URL for the short link for Android device targeting.
geo components.LinkGeoTargeting Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }.
doIndex boolean Allow search engines to index your short link. Defaults to false if not provided. Learn more: https://d.to/noindex
utmSource string The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL.
utmMedium string The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL.
utmCampaign string The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
utmTerm string The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
utmContent string The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
ref string The referral tag of the short link. If set, this will populate or override the ref query parameter in the destination URL.
programId string The ID of the program the short link is associated with.
webhookIds string[] An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.