POST
/
links
/
bulk
Go
package main

import(
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := dubgo.New(
        dubgo.WithSecurity("DUB_API_KEY"),
    )

    res, err := s.Links.CreateMany(ctx, []operations.RequestBody{
        operations.RequestBody{
            URL: "https://google.com",
            ExternalID: dubgo.String("123456"),
            TagIds: dubgo.Pointer(operations.CreateBulkCreateLinksTagIdsArrayOfStr(
                []string{
                    "clux0rgak00011...",
                },
            )),
            TestVariants: []operations.BulkCreateLinksTestVariants{
                operations.BulkCreateLinksTestVariants{
                    URL: "https://example.com/variant-1",
                    Percentage: 50,
                },
                operations.BulkCreateLinksTestVariants{
                    URL: "https://example.com/variant-2",
                    Percentage: 50,
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}
[
  {
    "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": {},
    "publicStats": false,
    "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,
    "leads": 0,
    "conversions": 0,
    "sales": 0,
    "saleAmount": 0,
    "lastClicked": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "tagId": "<string>",
    "projectId": "<string>"
  }
]
Bulk link creation does not support custom link previews. Also, webhook events will not be triggered when using this endpoint.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Body

application/json · object[]
​
url
string
required

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
​
keyLength
number

The length of the short link slug. Defaults to 7 if not provided. When used with prefix, the total length of the key will be prefix.length + keyLength.

Required range: 3 <= x <= 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.

​
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 Link Previews feature. Defaults to false if not provided.

​
title
string | null

The custom link preview title (og:title). Will be used for Custom Link Previews 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 Link Previews 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 Link Previews 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 Link Previews 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 }. See https://d.to/geo for more information.

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

Required array length: 2 - 4 elements
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.

​
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

Deprecated: Use tagIds instead. The unique ID of the tag assigned to the short link.

Response

The created links

​
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<uri>
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<uri> | 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 Link Previews feature.

​
title
string | null
required

The title of the short link. Will be used for Custom Link Previews if proxy is true.

​
description
string | null
required

The description of the short link. Will be used for Custom Link Previews if proxy is true.

​
image
string | null
required

The image of the short link. Will be used for Custom Link Previews if proxy is true.

​
video
string | null
required

The custom link preview video (og:video). Will be used for Custom Link Previews 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 }. See https://d.to/geo for more information.

​
publicStats
boolean
default:false
required

Whether the short link's stats are publicly accessible.

​
tags
Tag · 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<uri>
required

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

​
qrCode
string<uri>
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.

​
leads
number
default:0
required

The number of leads the short link has generated.

​
conversions
number
default:0
required

The number of leads that converted to paying customers.

​
sales
number
default:0
required

The total number of sales (includes recurring sales) generated by the short link.

​
saleAmount
number
default:0
required

The total dollar value of sales (in cents) generated by the short link.

​
lastClicked
string | null
required

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

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

​
tagId
string | null
required
deprecated

Deprecated: Use tags instead. The unique ID of the tag assigned to the short link.

​
projectId
string
required
deprecated

Deprecated: Use workspaceId instead. The project ID of the short link.

​
testVariants
object[] | null

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

Required array length: 2 - 4 elements
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.