PATCH
/
links
/
{linkId}
require 'dub'

s = ::OpenApiSDK::Dub.new(
      security: ::OpenApiSDK::Shared::Security.new(
        token: "DUB_API_KEY",
      ),
    )

res = s.links.update(link_id="<id>", request_body=::OpenApiSDK::Operations::UpdateLinkRequestBody.new(
  url: "https://google.com",
  external_id: "123456",
  tag_ids: [
    "clux0rgak00011...",
  ],
  test_variants: [
    ::OpenApiSDK::Operations::UpdateLinkTestVariants.new(
      url: "https://example.com/variant-1",
      percentage: 50.0,
    ),
    ::OpenApiSDK::Operations::UpdateLinkTestVariants.new(
      url: "https://example.com/variant-2",
      percentage: 50.0,
    ),
  ],
))

if ! res.link_schema.nil?
  # handle response
end
{
  "id": "<string>",
  "domain": "<string>",
  "key": "<string>",
  "url": "<string>",
  "trackConversion": false,
  "externalId": "<string>",
  "tenantId": "<string>",
  "programId": "<string>",
  "partnerId": "<string>",
  "archived": false,
  "expiresAt": "<string>",
  "expiredUrl": "<string>",
  "password": "<string>",
  "proxy": false,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "video": "<string>",
  "rewrite": false,
  "doIndex": false,
  "ios": "<string>",
  "android": "<string>",
  "geo": {
    "AF": "<string>",
    "AL": "<string>",
    "DZ": "<string>",
    "AS": "<string>",
    "AD": "<string>",
    "AO": "<string>",
    "AI": "<string>",
    "AQ": "<string>",
    "AG": "<string>",
    "AR": "<string>",
    "AM": "<string>",
    "AW": "<string>",
    "AU": "<string>",
    "AT": "<string>",
    "AZ": "<string>",
    "BS": "<string>",
    "BH": "<string>",
    "BD": "<string>",
    "BB": "<string>",
    "BY": "<string>",
    "BE": "<string>",
    "BZ": "<string>",
    "BJ": "<string>",
    "BM": "<string>",
    "BT": "<string>",
    "BO": "<string>",
    "BA": "<string>",
    "BW": "<string>",
    "BV": "<string>",
    "BR": "<string>",
    "IO": "<string>",
    "BN": "<string>",
    "BG": "<string>",
    "BF": "<string>",
    "BI": "<string>",
    "KH": "<string>",
    "CM": "<string>",
    "CA": "<string>",
    "CV": "<string>",
    "KY": "<string>",
    "CF": "<string>",
    "TD": "<string>",
    "CL": "<string>",
    "CN": "<string>",
    "CX": "<string>",
    "CC": "<string>",
    "CO": "<string>",
    "KM": "<string>",
    "CG": "<string>",
    "CD": "<string>",
    "CK": "<string>",
    "CR": "<string>",
    "CI": "<string>",
    "HR": "<string>",
    "CU": "<string>",
    "CY": "<string>",
    "CZ": "<string>",
    "DK": "<string>",
    "DJ": "<string>",
    "DM": "<string>",
    "DO": "<string>",
    "EC": "<string>",
    "EG": "<string>",
    "SV": "<string>",
    "GQ": "<string>",
    "ER": "<string>",
    "EE": "<string>",
    "ET": "<string>",
    "FK": "<string>",
    "FO": "<string>",
    "FJ": "<string>",
    "FI": "<string>",
    "FR": "<string>",
    "GF": "<string>",
    "PF": "<string>",
    "TF": "<string>",
    "GA": "<string>",
    "GM": "<string>",
    "GE": "<string>",
    "DE": "<string>",
    "GH": "<string>",
    "GI": "<string>",
    "GR": "<string>",
    "GL": "<string>",
    "GD": "<string>",
    "GP": "<string>",
    "GU": "<string>",
    "GT": "<string>",
    "GN": "<string>",
    "GW": "<string>",
    "GY": "<string>",
    "HT": "<string>",
    "HM": "<string>",
    "VA": "<string>",
    "HN": "<string>",
    "HK": "<string>",
    "HU": "<string>",
    "IS": "<string>",
    "IN": "<string>",
    "ID": "<string>",
    "IR": "<string>",
    "IQ": "<string>",
    "IE": "<string>",
    "IL": "<string>",
    "IT": "<string>",
    "JM": "<string>",
    "JP": "<string>",
    "JO": "<string>",
    "KZ": "<string>",
    "KE": "<string>",
    "KI": "<string>",
    "KP": "<string>",
    "KR": "<string>",
    "KW": "<string>",
    "KG": "<string>",
    "LA": "<string>",
    "LV": "<string>",
    "LB": "<string>",
    "LS": "<string>",
    "LR": "<string>",
    "LY": "<string>",
    "LI": "<string>",
    "LT": "<string>",
    "LU": "<string>",
    "MO": "<string>",
    "MG": "<string>",
    "MW": "<string>",
    "MY": "<string>",
    "MV": "<string>",
    "ML": "<string>",
    "MT": "<string>",
    "MH": "<string>",
    "MQ": "<string>",
    "MR": "<string>",
    "MU": "<string>",
    "YT": "<string>",
    "MX": "<string>",
    "FM": "<string>",
    "MD": "<string>",
    "MC": "<string>",
    "MN": "<string>",
    "MS": "<string>",
    "MA": "<string>",
    "MZ": "<string>",
    "MM": "<string>",
    "NA": "<string>",
    "NR": "<string>",
    "NP": "<string>",
    "NL": "<string>",
    "NC": "<string>",
    "NZ": "<string>",
    "NI": "<string>",
    "NE": "<string>",
    "NG": "<string>",
    "NU": "<string>",
    "NF": "<string>",
    "MK": "<string>",
    "MP": "<string>",
    "NO": "<string>",
    "OM": "<string>",
    "PK": "<string>",
    "PW": "<string>",
    "PS": "<string>",
    "PA": "<string>",
    "PG": "<string>",
    "PY": "<string>",
    "PE": "<string>",
    "PH": "<string>",
    "PN": "<string>",
    "PL": "<string>",
    "PT": "<string>",
    "PR": "<string>",
    "QA": "<string>",
    "RE": "<string>",
    "RO": "<string>",
    "RU": "<string>",
    "RW": "<string>",
    "SH": "<string>",
    "KN": "<string>",
    "LC": "<string>",
    "PM": "<string>",
    "VC": "<string>",
    "WS": "<string>",
    "SM": "<string>",
    "ST": "<string>",
    "SA": "<string>",
    "SN": "<string>",
    "SC": "<string>",
    "SL": "<string>",
    "SG": "<string>",
    "SK": "<string>",
    "SI": "<string>",
    "SB": "<string>",
    "SO": "<string>",
    "ZA": "<string>",
    "GS": "<string>",
    "ES": "<string>",
    "LK": "<string>",
    "SD": "<string>",
    "SR": "<string>",
    "SJ": "<string>",
    "SZ": "<string>",
    "SE": "<string>",
    "CH": "<string>",
    "SY": "<string>",
    "TW": "<string>",
    "TJ": "<string>",
    "TZ": "<string>",
    "TH": "<string>",
    "TL": "<string>",
    "TG": "<string>",
    "TK": "<string>",
    "TO": "<string>",
    "TT": "<string>",
    "TN": "<string>",
    "TR": "<string>",
    "TM": "<string>",
    "TC": "<string>",
    "TV": "<string>",
    "UG": "<string>",
    "UA": "<string>",
    "AE": "<string>",
    "GB": "<string>",
    "US": "<string>",
    "UM": "<string>",
    "UY": "<string>",
    "UZ": "<string>",
    "VU": "<string>",
    "VE": "<string>",
    "VN": "<string>",
    "VG": "<string>",
    "VI": "<string>",
    "WF": "<string>",
    "EH": "<string>",
    "YE": "<string>",
    "ZM": "<string>",
    "ZW": "<string>",
    "AX": "<string>",
    "BQ": "<string>",
    "CW": "<string>",
    "GG": "<string>",
    "IM": "<string>",
    "JE": "<string>",
    "ME": "<string>",
    "BL": "<string>",
    "MF": "<string>",
    "RS": "<string>",
    "SX": "<string>",
    "SS": "<string>",
    "XK": "<string>"
  },
  "publicStats": false,
  "tagId": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "red"
    }
  ],
  "folderId": "<string>",
  "webhookIds": [
    "<string>"
  ],
  "comments": "<string>",
  "shortLink": "<string>",
  "qrCode": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "testVariants": [
    {
      "url": "https://example.com/variant-1",
      "percentage": 50
    },
    {
      "url": "https://example.com/variant-2",
      "percentage": 50
    }
  ],
  "testStartedAt": "<string>",
  "testCompletedAt": "<string>",
  "userId": "<string>",
  "workspaceId": "<string>",
  "clicks": 0,
  "lastClicked": "<string>",
  "leads": 0,
  "sales": 0,
  "saleAmount": 0,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "projectId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
linkId
string
required

The id of the link to update. You may use either linkId (obtained via /links/info endpoint) or externalId prefixed with ext_.

Body

application/json
​
url
string

The destination URL of the short link.

Example:

"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).

Maximum length: 190
​
key
string

The short link slug. If not provided, a random 7-character slug will be generated.

Maximum length: 190
​
externalId
string | null

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.

Required string length: 1 - 255
Example:

"123456"

​
tenantId
string | null

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.

Maximum length: 255
​
programId
string | null

The ID of the program the short link is associated with.

​
partnerId
string | null

The ID of the partner the short link is associated with.

​
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
deprecated

Deprecated: Use dashboard instead. Whether the short link's stats are publicly accessible. Defaults to false if not provided.

​
tagId
string | null
deprecated

The unique ID of the tag assigned to the short link. This field is deprecated – use tagIds instead.

​
tagIds

The unique IDs of the tags assigned to the short link.

Example:
["clux0rgak00011..."]
​
tagNames

The unique name of the tags assigned to the short link (case insensitive).

​
folderId
string | null

The unique ID existing folder to assign the short link to.

​
comments
string | null

The comments for the short link.

​
expiresAt
string | null

The date and time when the short link will expire at.

​
expiredUrl
string | null

The URL to redirect to when the short link has expired.

​
password
string | null

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 | null

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 | null

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 | null

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 | null

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 | null

The iOS destination URL for the short link for iOS device targeting.

​
android
string | null

The Android destination URL for the short link for Android device targeting.

​
geo
object | null

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

​
utm_source
string | null

The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL.

​
utm_medium
string | null

The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL.

​
utm_campaign
string | null

The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.

​
utm_term
string | null

The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.

​
utm_content
string | null

The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.

​
ref
string | null

The referral tag of the short link. If set, this will populate or override the ref query parameter in the destination URL.

​
webhookIds
string[] | null

An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.

​
testVariants
object[] | null

An array of A/B test URLs and the percentage of traffic to send to each URL.

Example:
[
  {
    "url": "https://example.com/variant-1",
    "percentage": 50
  },
  {
    "url": "https://example.com/variant-2",
    "percentage": 50
  }
]
​
testStartedAt
string | null

The date and time when the tests started.

​
testCompletedAt
string | null

The date and time when the tests were or will be completed.

Response

200
application/json
The updated link
​
id
string
required

The unique ID of the short link.

​
domain
string
required

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
required

The short link slug. If not provided, a random 7-character slug will be generated.

​
url
string
required

The destination URL of the short link.

​
trackConversion
boolean
default:false
required

Whether to track conversions for the short link.

​
externalId
string | null
required

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.

​
tenantId
string | null
required

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.

​
programId
string | null
required

The ID of the program the short link is associated with.

​
partnerId
string | null
required

The ID of the partner the short link is associated with.

​
archived
boolean
default:false
required

Whether the short link is archived.

​
expiresAt
string | null
required

The date and time when the short link will expire in ISO-8601 format.

​
expiredUrl
string | null
required

The URL to redirect to when the short link has expired.

​
password
string | null
required

The password required to access the destination URL of the short link.

​
proxy
boolean
default:false
required

Whether the short link uses Custom Social Media Cards feature.

​
title
string | null
required

The title of the short link. Will be used for Custom Social Media Cards if proxy is true.

​
description
string | null
required

The description of the short link. Will be used for Custom Social Media Cards if proxy is true.

​
image
string | null
required

The image of the short link. Will be used for Custom Social Media Cards if proxy is true.

​
video
string | null
required

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
default:false
required

Whether the short link uses link cloaking.

​
doIndex
boolean
default:false
required

Whether to allow search engines to index the short link.

​
ios
string | null
required

The iOS destination URL for the short link for iOS device targeting.

​
android
string | null
required

The Android destination URL for the short link for Android device targeting.

​
geo
object | null
required

Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }. Learn more: https://d.to/geo

​
publicStats
boolean
default:false
required

Whether the short link's stats are publicly accessible.

​
tagId
string | null
required
deprecated

The unique ID of the tag assigned to the short link. This field is deprecated – use tags instead.

​
tags
object[] | null
required

The tags assigned to the short link.

​
folderId
string | null
required

The unique ID of the folder assigned to the short link.

​
webhookIds
string[]
required

The IDs of the webhooks that the short link is associated with.

​
comments
string | null
required

The comments for the short link.

​
shortLink
string
required

The full URL of the short link, including the https protocol (e.g. https://dub.sh/try).

​
qrCode
string
required

The full URL of the QR code for the short link (e.g. https://api.dub.co/qr?url=https://dub.sh/try).

​
utm_source
string | null
required

The UTM source of the short link.

​
utm_medium
string | null
required

The UTM medium of the short link.

​
utm_campaign
string | null
required

The UTM campaign of the short link.

​
utm_term
string | null
required

The UTM term of the short link.

​
utm_content
string | null
required

The UTM content of the short link.

​
userId
string | null
required

The user ID of the creator of the short link.

​
workspaceId
string
required

The workspace ID of the short link.

​
clicks
number
default:0
required

The number of clicks on the short link.

​
lastClicked
string | null
required

The date and time when the short link was last clicked.

​
leads
number
default:0
required

The number of leads the short links has generated.

​
sales
number
default:0
required

The number of sales the short links has generated.

​
saleAmount
number
default:0
required

The total dollar amount of sales the short links has generated (in cents).

​
createdAt
string
required

The date and time when the short link was created.

​
updatedAt
string
required

The date and time when the short link was last updated.

​
projectId
string
required
deprecated

The project ID of the short link. This field is deprecated – use workspaceId instead.

​
testVariants
object[] | null

An array of A/B test URLs and the percentage of traffic to send to each URL.

Example:
[
  {
    "url": "https://example.com/variant-1",
    "percentage": 50
  },
  {
    "url": "https://example.com/variant-2",
    "percentage": 50
  }
]
​
testStartedAt
string | null

The date and time when the tests started.

​
testCompletedAt
string | null

The date and time when the tests were or will be completed.

Was this page helpful?

Suggest editsRaise issue