Bulk update links

Bulk update up to 100 links with the same data for the authenticated workspace.

This endpoint lets you update up to 100 links with the same data.

Some potential use cases:

• Tagging multiple links at once
• Setting the same expiration date for multiple links
• Updating UTM parameters for multiple links

You cannot update the domain or key of a link with this endpoint. Also, webhook events will not be triggered when using this endpoint.

Authorizations

Authorization

string

header

required

Default authentication mechanism

Body

application/json

data

object

required

Show child attributes

data.android

string | null

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

data.archived

boolean

default:

false

Whether the short link is archived.

data.comments

string | null

The comments for the short link.

data.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

data.doIndex

boolean

default:

false

Allow search engines to index your short link. Defaults to false if not provided. Learn more: https://d.to/noindex

data.expiredUrl

string | null

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

data.expiresAt

string | null

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

data.geo

object | null

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

Show child attributes

data.geo.AD

string

data.geo.AE

string

data.geo.AF

string

data.geo.AG

string

data.geo.AI

string

data.geo.AL

string

data.geo.AM

string

data.geo.AO

string

data.geo.AQ

string

data.geo.AR

string

data.geo.AS

string

data.geo.AT

string

data.geo.AU

string

data.geo.AW

string

data.geo.AX

string

data.geo.AZ

string

data.geo.BA

string

data.geo.BB

string

data.geo.BD

string

data.geo.BE

string

data.geo.BF

string

data.geo.BG

string

data.geo.BH

string

data.geo.BI

string

data.geo.BJ

string

data.geo.BL

string

data.geo.BM

string

data.geo.BN

string

data.geo.BO

string

data.geo.BQ

string

data.geo.BR

string

data.geo.BS

string

data.geo.BT

string

data.geo.BV

string

data.geo.BW

string

data.geo.BY

string

data.geo.BZ

string

data.geo.CA

string

data.geo.CC

string

data.geo.CD

string

data.geo.CF

string

data.geo.CG

string

data.geo.CH

string

data.geo.CI

string

data.geo.CK

string

data.geo.CL

string

data.geo.CM

string

data.geo.CN

string

data.geo.CO

string

data.geo.CR

string

data.geo.CU

string

data.geo.CV

string

data.geo.CW

string

data.geo.CX

string

data.geo.CY

string

data.geo.CZ

string

data.geo.DE

string

data.geo.DJ

string

data.geo.DK

string

data.geo.DM

string

data.geo.DO

string

data.geo.DZ

string

data.geo.EC

string

data.geo.EE

string

data.geo.EG

string

data.geo.EH

string

data.geo.ER

string

data.geo.ES

string

data.geo.ET

string

data.geo.FI

string

data.geo.FJ

string

data.geo.FK

string

data.geo.FM

string

data.geo.FO

string

data.geo.FR

string

data.geo.GA

string

data.geo.GB

string

data.geo.GD

string

data.geo.GE

string

data.geo.GF

string

data.geo.GG

string

data.geo.GH

string

data.geo.GI

string

data.geo.GL

string

data.geo.GM

string

data.geo.GN

string

data.geo.GP

string

data.geo.GQ

string

data.geo.GR

string

data.geo.GS

string

data.geo.GT

string

data.geo.GU

string

data.geo.GW

string

data.geo.GY

string

data.geo.HK

string

data.geo.HM

string

data.geo.HN

string

data.geo.HR

string

data.geo.HT

string

data.geo.HU

string

data.geo.ID

string

data.geo.IE

string

data.geo.IL

string

data.geo.IM

string

data.geo.IN

string

data.geo.IO

string

data.geo.IQ

string

data.geo.IR

string

data.geo.IS

string

data.geo.IT

string

data.geo.JE

string

data.geo.JM

string

data.geo.JO

string

data.geo.JP

string

data.geo.KE

string

data.geo.KG

string

data.geo.KH

string

data.geo.KI

string

data.geo.KM

string

data.geo.KN

string

data.geo.KP

string

data.geo.KR

string

data.geo.KW

string

data.geo.KY

string

data.geo.KZ

string

data.geo.LA

string

data.geo.LB

string

data.geo.LC

string

data.geo.LI

string

data.geo.LK

string

data.geo.LR

string

data.geo.LS

string

data.geo.LT

string

data.geo.LU

string

data.geo.LV

string

data.geo.LY

string

data.geo.MA

string

data.geo.MC

string

data.geo.MD

string

data.geo.ME

string

data.geo.MF

string

data.geo.MG

string

data.geo.MH

string

data.geo.MK

string

data.geo.ML

string

data.geo.MM

string

data.geo.MN

string

data.geo.MO

string

data.geo.MP

string

data.geo.MQ

string

data.geo.MR

string

data.geo.MS

string

data.geo.MT

string

data.geo.MU

string

data.geo.MV

string

data.geo.MW

string

data.geo.MX

string

data.geo.MY

string

data.geo.MZ

string

data.geo.NA

string

data.geo.NC

string

data.geo.NE

string

data.geo.NF

string

data.geo.NG

string

data.geo.NI

string

data.geo.NL

string

data.geo.NO

string

data.geo.NP

string

data.geo.NR

string

data.geo.NU

string

data.geo.NZ

string

data.geo.OM

string

data.geo.PA

string

data.geo.PE

string

data.geo.PF

string

data.geo.PG

string

data.geo.PH

string

data.geo.PK

string

data.geo.PL

string

data.geo.PM

string

data.geo.PN

string

data.geo.PR

string

data.geo.PS

string

data.geo.PT

string

data.geo.PW

string

data.geo.PY

string

data.geo.QA

string

data.geo.RE

string

data.geo.RO

string

data.geo.RS

string

data.geo.RU

string

data.geo.RW

string

data.geo.SA

string

data.geo.SB

string

data.geo.SC

string

data.geo.SD

string

data.geo.SE

string

data.geo.SG

string

data.geo.SH

string

data.geo.SI

string

data.geo.SJ

string

data.geo.SK

string

data.geo.SL

string

data.geo.SM

string

data.geo.SN

string

data.geo.SO

string

data.geo.SR

string

data.geo.SS

string

data.geo.ST

string

data.geo.SV

string

data.geo.SX

string

data.geo.SY

string

data.geo.SZ

string

data.geo.TC

string

data.geo.TD

string

data.geo.TF

string

data.geo.TG

string

data.geo.TH

string

data.geo.TJ

string

data.geo.TK

string

data.geo.TL

string

data.geo.TM

string

data.geo.TN

string

data.geo.TO

string

data.geo.TR

string

data.geo.TT

string

data.geo.TV

string

data.geo.TW

string

data.geo.TZ

string

data.geo.UA

string

data.geo.UG

string

data.geo.UM

string

data.geo.US

string

data.geo.UY

string

data.geo.UZ

string

data.geo.VA

string

data.geo.VC

string

data.geo.VE

string

data.geo.VG

string

data.geo.VI

string

data.geo.VN

string

data.geo.VU

string

data.geo.WF

string

data.geo.WS

string

data.geo.XK

string

data.geo.YE

string

data.geo.YT

string

data.geo.ZA

string

data.geo.ZM

string

data.geo.ZW

string

data.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

data.ios

string | null

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

data.password

string | null

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

data.programId

string | null

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

data.proxy

boolean

default:

false

Whether the short link uses Custom Social Media Cards feature.

data.publicStats

boolean

default:

false

deprecated

Deprecated: Use dashboard instead. Whether the short link's stats are publicly accessible.

data.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.

data.rewrite

boolean

default:

false

Whether the short link uses link cloaking.

data.tagId

string | null

deprecated

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

data.tagIds

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

data.tagNames

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

data.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

data.trackConversion

boolean

default:

false

Whether to track conversions for the short link.

data.url

string

The destination URL of the short link.

data.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.

data.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.

data.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.

data.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.

data.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.

data.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

data.webhookIds

string[] | null

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

externalIds

string[]

The external IDs of the links to update as stored in your database.

linkIds

string[]

The IDs of the links to update. Takes precedence over externalIds.

Response

200 - application/json

android

string | null

required

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

archived

boolean

default:

false

required

Whether the short link is archived.

clicks

number

default:

0

required

The number of clicks on the short link.

comments

string | null

required

The comments for the short link.

createdAt

string

required

The date and time when the short link was created.

description

string | null

required

The description of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.

doIndex

boolean

default:

false

required

Whether to allow search engines to index 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).

expiredUrl

string | null

required

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

expiresAt

string | null

required

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

externalId

string | null

required

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.

geo

object | null

required

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

Show child attributes

geo.AD

string

geo.AE

string

geo.AF

string

geo.AG

string

geo.AI

string

geo.AL

string

geo.AM

string

geo.AO

string

geo.AQ

string

geo.AR

string

geo.AS

string

geo.AT

string

geo.AU

string

geo.AW

string

geo.AX

string

geo.AZ

string

geo.BA

string

geo.BB

string

geo.BD

string

geo.BE

string

geo.BF

string

geo.BG

string

geo.BH

string

geo.BI

string

geo.BJ

string

geo.BL

string

geo.BM

string

geo.BN

string

geo.BO

string

geo.BQ

string

geo.BR

string

geo.BS

string

geo.BT

string

geo.BV

string

geo.BW

string

geo.BY

string

geo.BZ

string

geo.CA

string

geo.CC

string

geo.CD

string

geo.CF

string

geo.CG

string

geo.CH

string

geo.CI

string

geo.CK

string

geo.CL

string

geo.CM

string

geo.CN

string

geo.CO

string

geo.CR

string

geo.CU

string

geo.CV

string

geo.CW

string

geo.CX

string

geo.CY

string

geo.CZ

string

geo.DE

string

geo.DJ

string

geo.DK

string

geo.DM

string

geo.DO

string

geo.DZ

string

geo.EC

string

geo.EE

string

geo.EG

string

geo.EH

string

geo.ER

string

geo.ES

string

geo.ET

string

geo.FI

string

geo.FJ

string

geo.FK

string

geo.FM

string

geo.FO

string

geo.FR

string

geo.GA

string

geo.GB

string

geo.GD

string

geo.GE

string

geo.GF

string

geo.GG

string

geo.GH

string

geo.GI

string

geo.GL

string

geo.GM

string

geo.GN

string

geo.GP

string

geo.GQ

string

geo.GR

string

geo.GS

string

geo.GT

string

geo.GU

string

geo.GW

string

geo.GY

string

geo.HK

string

geo.HM

string

geo.HN

string

geo.HR

string

geo.HT

string

geo.HU

string

geo.ID

string

geo.IE

string

geo.IL

string

geo.IM

string

geo.IN

string

geo.IO

string

geo.IQ

string

geo.IR

string

geo.IS

string

geo.IT

string

geo.JE

string

geo.JM

string

geo.JO

string

geo.JP

string

geo.KE

string

geo.KG

string

geo.KH

string

geo.KI

string

geo.KM

string

geo.KN

string

geo.KP

string

geo.KR

string

geo.KW

string

geo.KY

string

geo.KZ

string

geo.LA

string

geo.LB

string

geo.LC

string

geo.LI

string

geo.LK

string

geo.LR

string

geo.LS

string

geo.LT

string

geo.LU

string

geo.LV

string

geo.LY

string

geo.MA

string

geo.MC

string

geo.MD

string

geo.ME

string

geo.MF

string

geo.MG

string

geo.MH

string

geo.MK

string

geo.ML

string

geo.MM

string

geo.MN

string

geo.MO

string

geo.MP

string

geo.MQ

string

geo.MR

string

geo.MS

string

geo.MT

string

geo.MU

string

geo.MV

string

geo.MW

string

geo.MX

string

geo.MY

string

geo.MZ

string

geo.NA

string

geo.NC

string

geo.NE

string

geo.NF

string

geo.NG

string

geo.NI

string

geo.NL

string

geo.NO

string

geo.NP

string

geo.NR

string

geo.NU

string

geo.NZ

string

geo.OM

string

geo.PA

string

geo.PE

string

geo.PF

string

geo.PG

string

geo.PH

string

geo.PK

string

geo.PL

string

geo.PM

string

geo.PN

string

geo.PR

string

geo.PS

string

geo.PT

string

geo.PW

string

geo.PY

string

geo.QA

string

geo.RE

string

geo.RO

string

geo.RS

string

geo.RU

string

geo.RW

string

geo.SA

string

geo.SB

string

geo.SC

string

geo.SD

string

geo.SE

string

geo.SG

string

geo.SH

string

geo.SI

string

geo.SJ

string

geo.SK

string

geo.SL

string

geo.SM

string

geo.SN

string

geo.SO

string

geo.SR

string

geo.SS

string

geo.ST

string

geo.SV

string

geo.SX

string

geo.SY

string

geo.SZ

string

geo.TC

string

geo.TD

string

geo.TF

string

geo.TG

string

geo.TH

string

geo.TJ

string

geo.TK

string

geo.TL

string

geo.TM

string

geo.TN

string

geo.TO

string

geo.TR

string

geo.TT

string

geo.TV

string

geo.TW

string

geo.TZ

string

geo.UA

string

geo.UG

string

geo.UM

string

geo.US

string

geo.UY

string

geo.UZ

string

geo.VA

string

geo.VC

string

geo.VE

string

geo.VG

string

geo.VI

string

geo.VN

string

geo.VU

string

geo.WF

string

geo.WS

string

geo.XK

string

geo.YE

string

geo.YT

string

geo.ZA

string

geo.ZM

string

geo.ZW

string

id

string

required

The unique ID of the short link.

identifier

string | null

required

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.

image

string | null

required

The image of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.

ios

string | null

required

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

key

string

required

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

lastClicked

string | null

required

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

leads

number

default:

0

required

[BETA]: The number of leads the short links has generated.

password

string | null

required

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

programId

string | null

required

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

projectId

string

requireddeprecated

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

proxy

boolean

default:

false

required

Whether the short link uses Custom Social Media Cards feature.

publicStats

boolean

default:

false

required

Whether the short link's stats are publicly accessible.

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

rewrite

boolean

default:

false

required

Whether the short link uses link cloaking.

saleAmount

number

default:

0

required

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

sales

number

default:

0

required

[BETA]: The number of sales the short links has generated.

shortLink

string

required

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

tagId

string | null

requireddeprecated

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.

Show child attributes

tags.color

enum<string>

required

The color of the tag.

Available options:

red,

yellow,

green,

blue,

purple,

pink,

brown

tags.id

string

required

The unique ID of the tag.

tags.name

string

required

The name of the tag.

title

string | null

required

The title of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.

trackConversion

boolean

default:

false

required

[BETA] Whether to track conversions for the short link.

updatedAt

string

required

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

url

string

required

The destination URL of the short link.

userId

string | null

required

The user ID of the creator of the short link.

utm_campaign

string | null

required

The UTM campaign of the short link.

utm_content

string | null

required

The UTM content of the short link.

utm_medium

string | null

required

The UTM medium of the short link.

utm_source

string | null

required

The UTM source of the short link.

utm_term

string | null

required

The UTM term of the short link.

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

webhookIds

string[]

required

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

workspaceId

string

required

The workspace ID of the short link.