dub-node/docs/models/operations/createlinkrequestbody.md

CreateLinkRequestBody

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	➖	This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with ext_ when passed as a query parameter.	123456
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.
archived	boolean	➖	Whether the short link is archived.
publicStats	boolean	➖	Whether the short link's stats are publicly accessible.
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.
title	string	➖	The title of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
description	string	➖	The description of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
image	string	➖	The image of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
rewrite	boolean	➖	Whether the short link uses link cloaking.
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	operations.Geo	➖	Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }.