Upsert a link
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.
Authorizations
Default authentication mechanism
Body
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).
190The short link slug. If not provided, a random 7-character slug will be generated.
190This 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.
1 - 255The 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 to track conversions for the short link.
The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
Whether the short link is archived.
Deprecated: Use dashboard instead. 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 unique name of the tags assigned to the short link (case insensitive).
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 custom link preview title (og:title). Will be used for Custom Social Media Cards if proxy is true. Learn more: https://d.to/og
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
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
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
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.
Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }.
Allow search engines to index your short link. Defaults to false if not provided. Learn more: https://d.to/noindex
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.
The referral tag of the short link. If set, this will populate or override the ref query parameter in the destination URL.
The ID of the program the short link is associated with.
An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
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.
The destination URL of the short link.
[BETA] Whether to track conversions for the short link.
This is the ID of the link in your database that is unique across your workspace. 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.
The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
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.
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
Whether the short link uses link cloaking.
Whether to allow search engines to index the short link.
The iOS destination URL for the short link for iOS device targeting.
The Android destination URL for the short link for Android device targeting.
Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }. Learn more: https://d.to/geo
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 IDs of the webhooks that the short link is associated with.
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.
[BETA]: The number of leads the short links has generated.
[BETA]: The number of sales the short links has generated.
[BETA]: The total dollar amount of sales the short links has generated (in cents).
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.
The ID of the program the short link is associated with.
Was this page helpful?