Bulk update links with the Dub.co API

PATCH

links

bulk

object

linkIds

array

externalIds

array

data

object

url

string

trackConversion

boolean

archived

boolean

publicStats

boolean, deprecated

tagId

string, deprecated

tagIds

string

tagNames

string

comments

string

expiresAt

string

expiredUrl

string

password

string

proxy

boolean

title

string

description

string

image

string

video

string

rewrite

boolean

ios

string

android

string

geo

object

string

doIndex

boolean

utm_source

string

utm_medium

string

utm_campaign

string

utm_term

string

utm_content

string

ref

string

programId

string

webhookIds

array

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

headerrequired

Default authentication mechanism

Body

application/json

data

object

required

data.url

string

The destination URL of the short link.

data.trackConversion

boolean

default: false

Whether to track conversions for the short link.

data.archived

boolean

default: false

Whether the short link is archived.

data.publicStats

boolean

default: falsedeprecated

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

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

string | null

The comments for the short link.

data.expiresAt

string | null

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

data.expiredUrl

string | null

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

data.password

string | null

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

data.proxy

boolean

default: false

Whether the short link uses Custom Social Media Cards feature.

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

boolean

default: false

Whether the short link uses link cloaking.

data.ios

string | null

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

data.android

string | null

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

data.geo

object | null

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

data.geo.AF

string

data.geo.AL

string

data.geo.DZ

string

data.geo.AS

string

data.geo.AD

string

data.geo.AO

string

data.geo.AI

string

data.geo.AQ

string

data.geo.AG

string

data.geo.AR

string

data.geo.AM

string

data.geo.AW

string

data.geo.AU

string

data.geo.AT

string

data.geo.AZ

string

data.geo.BS

string

data.geo.BH

string

data.geo.BD

string

data.geo.BB

string

data.geo.BY

string

data.geo.BE

string

data.geo.BZ

string

data.geo.BJ

string

data.geo.BM

string

data.geo.BT

string

data.geo.BO

string

data.geo.BA

string

data.geo.BW

string

data.geo.BV

string

data.geo.BR

string

data.geo.IO

string

data.geo.BN

string

data.geo.BG

string

data.geo.BF

string

data.geo.BI

string

data.geo.KH

string

data.geo.CM

string

data.geo.CA

string

data.geo.CV

string

data.geo.KY

string

data.geo.CF

string

data.geo.TD

string

data.geo.CL

string

data.geo.CN

string

data.geo.CX

string

data.geo.CC

string

data.geo.CO

string

data.geo.KM

string

data.geo.CG

string

data.geo.CD

string

data.geo.CK

string

data.geo.CR

string

data.geo.CI

string

data.geo.HR

string

data.geo.CU

string

data.geo.CY

string

data.geo.CZ

string

data.geo.DK

string

data.geo.DJ

string

data.geo.DM

string

data.geo.DO

string

data.geo.EC

string

data.geo.EG

string

data.geo.SV

string

data.geo.GQ

string

data.geo.ER

string

data.geo.EE

string

data.geo.ET

string

data.geo.FK

string

data.geo.FO

string

data.geo.FJ

string

data.geo.FI

string

data.geo.FR

string

data.geo.GF

string

data.geo.PF

string

data.geo.TF

string

data.geo.GA

string

data.geo.GM

string

data.geo.GE

string

data.geo.DE

string

data.geo.GH

string

data.geo.GI

string

data.geo.GR

string

data.geo.GL

string

data.geo.GD

string

data.geo.GP

string

data.geo.GU

string

data.geo.GT

string

data.geo.GN

string

data.geo.GW

string

data.geo.GY

string

data.geo.HT

string

data.geo.HM

string

data.geo.VA

string

data.geo.HN

string

data.geo.HK

string

data.geo.HU

string

data.geo.IS

string

data.geo.IN

string

data.geo.ID

string

data.geo.IR

string

data.geo.IQ

string

data.geo.IE

string

data.geo.IL

string

data.geo.IT

string

data.geo.JM

string

data.geo.JP

string

data.geo.JO

string

data.geo.KZ

string

data.geo.KE

string

data.geo.KI

string

data.geo.KP

string

data.geo.KR

string

data.geo.KW

string

data.geo.KG

string

data.geo.LA

string

data.geo.LV

string

data.geo.LB

string

data.geo.LS

string

data.geo.LR

string

data.geo.LY

string

data.geo.LI

string

data.geo.LT

string

data.geo.LU

string

data.geo.MO

string

data.geo.MG

string

data.geo.MW

string

data.geo.MY

string

data.geo.MV

string

data.geo.ML

string

data.geo.MT

string

data.geo.MH

string

data.geo.MQ

string

data.geo.MR

string

data.geo.MU

string

data.geo.YT

string

data.geo.MX

string

data.geo.FM

string

data.geo.MD

string

data.geo.MC

string

data.geo.MN

string

data.geo.MS

string

data.geo.MA

string

data.geo.MZ

string

data.geo.MM

string

data.geo.NA

string

data.geo.NR

string

data.geo.NP

string

data.geo.NL

string

data.geo.NC

string

data.geo.NZ

string

data.geo.NI

string

data.geo.NE

string

data.geo.NG

string

data.geo.NU

string

data.geo.NF

string

data.geo.MK

string

data.geo.MP

string

data.geo.NO

string

data.geo.OM

string

data.geo.PK

string

data.geo.PW

string

data.geo.PS

string

data.geo.PA

string

data.geo.PG

string

data.geo.PY

string

data.geo.PE

string

data.geo.PH

string

data.geo.PN

string

data.geo.PL

string

data.geo.PT

string

data.geo.PR

string

data.geo.QA

string

data.geo.RE

string

data.geo.RO

string

data.geo.RU

string

data.geo.RW

string

data.geo.SH

string

data.geo.KN

string

data.geo.LC

string

data.geo.PM

string

data.geo.VC

string

data.geo.WS

string

data.geo.SM

string

data.geo.ST

string

data.geo.SA

string

data.geo.SN

string

data.geo.SC

string

data.geo.SL

string

data.geo.SG

string

data.geo.SK

string

data.geo.SI

string

data.geo.SB

string

data.geo.SO

string

data.geo.ZA

string

data.geo.GS

string

data.geo.ES

string

data.geo.LK

string

data.geo.SD

string

data.geo.SR

string

data.geo.SJ

string

data.geo.SZ

string

data.geo.SE

string

data.geo.CH

string

data.geo.SY

string

data.geo.TW

string

data.geo.TJ

string

data.geo.TZ

string

data.geo.TH

string

data.geo.TL

string

data.geo.TG

string

data.geo.TK

string

data.geo.TO

string

data.geo.TT

string

data.geo.TN

string

data.geo.TR

string

data.geo.TM

string

data.geo.TC

string

data.geo.TV

string

data.geo.UG

string

data.geo.UA

string

data.geo.AE

string

data.geo.GB

string

data.geo.US

string

data.geo.UM

string

data.geo.UY

string

data.geo.UZ

string

data.geo.VU

string

data.geo.VE

string

data.geo.VN

string

data.geo.VG

string

data.geo.VI

string

data.geo.WF

string

data.geo.EH

string

data.geo.YE

string

data.geo.ZM

string

data.geo.ZW

string

data.geo.AX

string

data.geo.BQ

string

data.geo.CW

string

data.geo.GG

string

data.geo.IM

string

data.geo.JE

string

data.geo.ME

string

data.geo.BL

string

data.geo.MF

string

data.geo.RS

string

data.geo.SX

string

data.geo.SS

string

data.geo.XK

string

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.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_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_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_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.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.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.programId

string | null

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

data.webhookIds

string[] | null

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

linkIds

string[]

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

externalIds

string[]

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

Response

200 - application/json

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: falserequired

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

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.

archived

boolean

default: falserequired

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: falserequired

Whether the short link uses Custom Social Media Cards feature.

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.

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.

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.

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: falserequired

Whether the short link uses link cloaking.

doIndex

boolean

default: falserequired

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

geo.AF

string

geo.AL

string

geo.DZ

string

geo.AS

string

geo.AD

string

geo.AO

string

geo.AI

string

geo.AQ

string

geo.AG

string

geo.AR

string

geo.AM

string

geo.AW

string

geo.AU

string

geo.AT

string

geo.AZ

string

geo.BS

string

geo.BH

string

geo.BD

string

geo.BB

string

geo.BY

string

geo.BE

string

geo.BZ

string

geo.BJ

string

geo.BM

string

geo.BT

string

geo.BO

string

geo.BA

string

geo.BW

string

geo.BV

string

geo.BR

string

geo.IO

string

geo.BN

string

geo.BG

string

geo.BF

string

geo.BI

string

geo.KH

string

geo.CM

string

geo.CA

string

geo.CV

string

geo.KY

string

geo.CF

string

geo.TD

string

geo.CL

string

geo.CN

string

geo.CX

string

geo.CC

string

geo.CO

string

geo.KM

string

geo.CG

string

geo.CD

string

geo.CK

string

geo.CR

string

geo.CI

string

geo.HR

string

geo.CU

string

geo.CY

string

geo.CZ

string

geo.DK

string

geo.DJ

string

geo.DM

string

geo.DO

string

geo.EC

string

geo.EG

string

geo.SV

string

geo.GQ

string

geo.ER

string

geo.EE

string

geo.ET

string

geo.FK

string

geo.FO

string

geo.FJ

string

geo.FI

string

geo.FR

string

geo.GF

string

geo.PF

string

geo.TF

string

geo.GA

string

geo.GM

string

geo.GE

string

geo.DE

string

geo.GH

string

geo.GI

string

geo.GR

string

geo.GL

string

geo.GD

string

geo.GP

string

geo.GU

string

geo.GT

string

geo.GN

string

geo.GW

string

geo.GY

string

geo.HT

string

geo.HM

string

geo.VA

string

geo.HN

string

geo.HK

string

geo.HU

string

geo.IS

string

geo.IN

string

geo.ID

string

geo.IR

string

geo.IQ

string

geo.IE

string

geo.IL

string

geo.IT

string

geo.JM

string

geo.JP

string

geo.JO

string

geo.KZ

string

geo.KE

string

geo.KI

string

geo.KP

string

geo.KR

string

geo.KW

string

geo.KG

string

geo.LA

string

geo.LV

string

geo.LB

string

geo.LS

string

geo.LR

string

geo.LY

string

geo.LI

string

geo.LT

string

geo.LU

string

geo.MO

string

geo.MG

string

geo.MW

string

geo.MY

string

geo.MV

string

geo.ML

string

geo.MT

string

geo.MH

string

geo.MQ

string

geo.MR

string

geo.MU

string

geo.YT

string

geo.MX

string

geo.FM

string

geo.MD

string

geo.MC

string

geo.MN

string

geo.MS

string

geo.MA

string

geo.MZ

string

geo.MM

string

geo.NA

string

geo.NR

string

geo.NP

string

geo.NL

string

geo.NC

string

geo.NZ

string

geo.NI

string

geo.NE

string

geo.NG

string

geo.NU

string

geo.NF

string

geo.MK

string

geo.MP

string

geo.NO

string

geo.OM

string

geo.PK

string

geo.PW

string

geo.PS

string

geo.PA

string

geo.PG

string

geo.PY

string

geo.PE

string

geo.PH

string

geo.PN

string

geo.PL

string

geo.PT

string

geo.PR

string

geo.QA

string

geo.RE

string

geo.RO

string

geo.RU

string

geo.RW

string

geo.SH

string

geo.KN

string

geo.LC

string

geo.PM

string

geo.VC

string

geo.WS

string

geo.SM

string

geo.ST

string

geo.SA

string

geo.SN

string

geo.SC

string

geo.SL

string

geo.SG

string

geo.SK

string

geo.SI

string

geo.SB

string

geo.SO

string

geo.ZA

string

geo.GS

string

geo.ES

string

geo.LK

string

geo.SD

string

geo.SR

string

geo.SJ

string

geo.SZ

string

geo.SE

string

geo.CH

string

geo.SY

string

geo.TW

string

geo.TJ

string

geo.TZ

string

geo.TH

string

geo.TL

string

geo.TG

string

geo.TK

string

geo.TO

string

geo.TT

string

geo.TN

string

geo.TR

string

geo.TM

string

geo.TC

string

geo.TV

string

geo.UG

string

geo.UA

string

geo.AE

string

geo.GB

string

geo.US

string

geo.UM

string

geo.UY

string

geo.UZ

string

geo.VU

string

geo.VE

string

geo.VN

string

geo.VG

string

geo.VI

string

geo.WF

string

geo.EH

string

geo.YE

string

geo.ZM

string

geo.ZW

string

geo.AX

string

geo.BQ

string

geo.CW

string

geo.GG

string

geo.IM

string

geo.JE

string

geo.ME

string

geo.BL

string

geo.MF

string

geo.RS

string

geo.SX

string

geo.SS

string

geo.XK

string

publicStats

boolean

default: falserequired

Whether the short link's stats are publicly accessible.

tagId

string | null

requireddeprecated

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

API Reference

Links

Analytics

Events

Tags

Domains

Workspaces

Conversions [BETA]

Customers

Bulk update links

Authorizations

Body

Response