Upsert
Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created.
Arguments
The destination URL of the short link.
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).
The short link slug. If not provided, a random 7-character slug will be generated.
This is the ID of the link in your database. If set, it can be used to identify the link in the future.
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.
Whether the short link is archived.
Whether the short link’s stats are publicly accessible.
The unique ID of the tag assigned to the short link. This field is deprecated
– use tagIds instead.
The unique IDs of the tags assigned to the short link.
The comments for the short link.
The date and time when the short link will expire at.
The URL to redirect to when the short link has expired.
The password required to access the destination URL of the short link.
Whether the short link uses Custom Social Media Cards feature.
The title of the short link generated via api.dub.co/metatags. Will be used
for Custom Social Media Cards if proxy is true.
The description of the short link generated via api.dub.co/metatags. Will be
used for Custom Social Media Cards if proxy is true.
The image of the short link generated via api.dub.co/metatags. Will be used
for Custom Social Media Cards if proxy is true.
Whether the short link uses link cloaking.
The iOS destination URL for the short link for iOS device targeting.
The Android destination URL for the short link for Android device targeting.
The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL.
The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL.
The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
Response
The unique ID of the short link.
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).
The short link slug. If not provided, a random 7-character slug will be generated.
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 provided to
links.get, links.update, and links.delete methods.
The destination URL of the short link.
Whether the short link is archived.
The date and time when the short link will expire in ISO-8601 format.
The URL to redirect to when the short link has expired.
The password required to access the destination URL of the short link.
Whether the short link uses Custom Social Media Cards feature.
The title of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
The description of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
The image of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
Whether the short link uses link cloaking.
The iOS destination URL for the short link for iOS device targeting.
The Android destination URL for the short link for Android device targeting.
Whether the short link’s stats are publicly accessible.
The unique ID of the tag assigned to the short link. This field is deprecated
– use tags instead.
The tags assigned to the short link.
The comments for the short link.
The full URL of the short link, including the https protocol (e.g.
https://dub.sh/try).
The full URL of the QR code for the short link (e.g.
https://api.dub.co/qr?url=https://dub.sh/try).
The UTM source of the short link.
The UTM medium of the short link.
The UTM campaign of the short link.
The UTM term of the short link.
The UTM content of the short link.
The user ID of the creator of the short link.
The workspace ID of the short link.
The number of clicks on the short link.
The date and time when the short link was last clicked.
The date and time when the short link was created.
The date and time when the short link was last updated.
The project ID of the short link. This field is deprecated – use workspaceId
instead.