Create a link

curl --request POST \
  --url https://api.dub.co/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://google.com",
  "domain": "<string>",
  "key": "<string>",
  "keyLength": 96,
  "externalId": "123456",
  "tenantId": "<string>",
  "programId": "<string>",
  "partnerId": "<string>",
  "prefix": "<string>",
  "trackConversion": true,
  "archived": true,
  "tagIds": [
    "clux0rgak00011..."
  ],
  "tagNames": "<string>",
  "folderId": "<string>",
  "comments": "<string>",
  "expiresAt": "<string>",
  "expiredUrl": "<string>",
  "password": "<string>",
  "proxy": true,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "video": "<string>",
  "rewrite": true,
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "doIndex": true,
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "ref": "<string>",
  "testVariants": [
    {
      "url": "https://example.com/variant-1",
      "percentage": 50
    },
    {
      "url": "https://example.com/variant-2",
      "percentage": 50
    }
  ],
  "testStartedAt": "<string>",
  "testCompletedAt": "<string>",
  "publicStats": true,
  "tagId": "<string>",
  "webhookIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.dub.co/links"

payload = {
    "url": "https://google.com",
    "domain": "<string>",
    "key": "<string>",
    "keyLength": 96,
    "externalId": "123456",
    "tenantId": "<string>",
    "programId": "<string>",
    "partnerId": "<string>",
    "prefix": "<string>",
    "trackConversion": True,
    "archived": True,
    "tagIds": ["clux0rgak00011..."],
    "tagNames": "<string>",
    "folderId": "<string>",
    "comments": "<string>",
    "expiresAt": "<string>",
    "expiredUrl": "<string>",
    "password": "<string>",
    "proxy": True,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "video": "<string>",
    "rewrite": True,
    "ios": "<string>",
    "android": "<string>",
    "geo": {},
    "doIndex": True,
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "ref": "<string>",
    "testVariants": [
        {
            "url": "https://example.com/variant-1",
            "percentage": 50
        },
        {
            "url": "https://example.com/variant-2",
            "percentage": 50
        }
    ],
    "testStartedAt": "<string>",
    "testCompletedAt": "<string>",
    "publicStats": True,
    "tagId": "<string>",
    "webhookIds": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://google.com',
    domain: '<string>',
    key: '<string>',
    keyLength: 96,
    externalId: '123456',
    tenantId: '<string>',
    programId: '<string>',
    partnerId: '<string>',
    prefix: '<string>',
    trackConversion: true,
    archived: true,
    tagIds: ['clux0rgak00011...'],
    tagNames: '<string>',
    folderId: '<string>',
    comments: '<string>',
    expiresAt: '<string>',
    expiredUrl: '<string>',
    password: '<string>',
    proxy: true,
    title: '<string>',
    description: '<string>',
    image: '<string>',
    video: '<string>',
    rewrite: true,
    ios: '<string>',
    android: '<string>',
    geo: {},
    doIndex: true,
    utm_source: '<string>',
    utm_medium: '<string>',
    utm_campaign: '<string>',
    utm_term: '<string>',
    utm_content: '<string>',
    ref: '<string>',
    testVariants: [
      {url: 'https://example.com/variant-1', percentage: 50},
      {url: 'https://example.com/variant-2', percentage: 50}
    ],
    testStartedAt: '<string>',
    testCompletedAt: '<string>',
    publicStats: true,
    tagId: '<string>',
    webhookIds: ['<string>']
  })
};

fetch('https://api.dub.co/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dub.co/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://google.com',
    'domain' => '<string>',
    'key' => '<string>',
    'keyLength' => 96,
    'externalId' => '123456',
    'tenantId' => '<string>',
    'programId' => '<string>',
    'partnerId' => '<string>',
    'prefix' => '<string>',
    'trackConversion' => true,
    'archived' => true,
    'tagIds' => [
        'clux0rgak00011...'
    ],
    'tagNames' => '<string>',
    'folderId' => '<string>',
    'comments' => '<string>',
    'expiresAt' => '<string>',
    'expiredUrl' => '<string>',
    'password' => '<string>',
    'proxy' => true,
    'title' => '<string>',
    'description' => '<string>',
    'image' => '<string>',
    'video' => '<string>',
    'rewrite' => true,
    'ios' => '<string>',
    'android' => '<string>',
    'geo' => [
        
    ],
    'doIndex' => true,
    'utm_source' => '<string>',
    'utm_medium' => '<string>',
    'utm_campaign' => '<string>',
    'utm_term' => '<string>',
    'utm_content' => '<string>',
    'ref' => '<string>',
    'testVariants' => [
        [
                'url' => 'https://example.com/variant-1',
                'percentage' => 50
        ],
        [
                'url' => 'https://example.com/variant-2',
                'percentage' => 50
        ]
    ],
    'testStartedAt' => '<string>',
    'testCompletedAt' => '<string>',
    'publicStats' => true,
    'tagId' => '<string>',
    'webhookIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/links"

	payload := strings.NewReader("{\n  \"url\": \"https://google.com\",\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"keyLength\": 96,\n  \"externalId\": \"123456\",\n  \"tenantId\": \"<string>\",\n  \"programId\": \"<string>\",\n  \"partnerId\": \"<string>\",\n  \"prefix\": \"<string>\",\n  \"trackConversion\": true,\n  \"archived\": true,\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": true,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"video\": \"<string>\",\n  \"rewrite\": true,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"doIndex\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"ref\": \"<string>\",\n  \"testVariants\": [\n    {\n      \"url\": \"https://example.com/variant-1\",\n      \"percentage\": 50\n    },\n    {\n      \"url\": \"https://example.com/variant-2\",\n      \"percentage\": 50\n    }\n  ],\n  \"testStartedAt\": \"<string>\",\n  \"testCompletedAt\": \"<string>\",\n  \"publicStats\": true,\n  \"tagId\": \"<string>\",\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dub.co/links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://google.com\",\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"keyLength\": 96,\n  \"externalId\": \"123456\",\n  \"tenantId\": \"<string>\",\n  \"programId\": \"<string>\",\n  \"partnerId\": \"<string>\",\n  \"prefix\": \"<string>\",\n  \"trackConversion\": true,\n  \"archived\": true,\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": true,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"video\": \"<string>\",\n  \"rewrite\": true,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"doIndex\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"ref\": \"<string>\",\n  \"testVariants\": [\n    {\n      \"url\": \"https://example.com/variant-1\",\n      \"percentage\": 50\n    },\n    {\n      \"url\": \"https://example.com/variant-2\",\n      \"percentage\": 50\n    }\n  ],\n  \"testStartedAt\": \"<string>\",\n  \"testCompletedAt\": \"<string>\",\n  \"publicStats\": true,\n  \"tagId\": \"<string>\",\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dub.co/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://google.com\",\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"keyLength\": 96,\n  \"externalId\": \"123456\",\n  \"tenantId\": \"<string>\",\n  \"programId\": \"<string>\",\n  \"partnerId\": \"<string>\",\n  \"prefix\": \"<string>\",\n  \"trackConversion\": true,\n  \"archived\": true,\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": true,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"video\": \"<string>\",\n  \"rewrite\": true,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"doIndex\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"ref\": \"<string>\",\n  \"testVariants\": [\n    {\n      \"url\": \"https://example.com/variant-1\",\n      \"percentage\": 50\n    },\n    {\n      \"url\": \"https://example.com/variant-2\",\n      \"percentage\": 50\n    }\n  ],\n  \"testStartedAt\": \"<string>\",\n  \"testCompletedAt\": \"<string>\",\n  \"publicStats\": true,\n  \"tagId\": \"<string>\",\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "domain": "<string>",
  "key": "<string>",
  "url": "<string>",
  "trackConversion": false,
  "externalId": "<string>",
  "tenantId": "<string>",
  "programId": "<string>",
  "partnerId": "<string>",
  "archived": false,
  "expiresAt": "<string>",
  "expiredUrl": "<string>",
  "disabledAt": "<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>",
  "comments": "<string>",
  "shortLink": "<string>",
  "qrCode": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<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>",
  "webhookIds": [
    "<string>"
  ],
  "testVariants": [
    {
      "url": "https://example.com/variant-1",
      "percentage": 50
    },
    {
      "url": "https://example.com/variant-2",
      "percentage": 50
    }
  ],
  "testStartedAt": "<string>",
  "testCompletedAt": "<string>"
}

{
  "error": {
    "code": "bad_request",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#bad-request"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#forbidden"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#not-found"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#conflict"
  }
}

{
  "error": {
    "code": "invite_expired",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"
  }
}

{
  "error": {
    "code": "internal_server_error",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"
  }
}

POST

links

Create a link

curl --request POST \
  --url https://api.dub.co/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://google.com",
  "domain": "<string>",
  "key": "<string>",
  "keyLength": 96,
  "externalId": "123456",
  "tenantId": "<string>",
  "programId": "<string>",
  "partnerId": "<string>",
  "prefix": "<string>",
  "trackConversion": true,
  "archived": true,
  "tagIds": [
    "clux0rgak00011..."
  ],
  "tagNames": "<string>",
  "folderId": "<string>",
  "comments": "<string>",
  "expiresAt": "<string>",
  "expiredUrl": "<string>",
  "password": "<string>",
  "proxy": true,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "video": "<string>",
  "rewrite": true,
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "doIndex": true,
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "ref": "<string>",
  "testVariants": [
    {
      "url": "https://example.com/variant-1",
      "percentage": 50
    },
    {
      "url": "https://example.com/variant-2",
      "percentage": 50
    }
  ],
  "testStartedAt": "<string>",
  "testCompletedAt": "<string>",
  "publicStats": true,
  "tagId": "<string>",
  "webhookIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.dub.co/links"

payload = {
    "url": "https://google.com",
    "domain": "<string>",
    "key": "<string>",
    "keyLength": 96,
    "externalId": "123456",
    "tenantId": "<string>",
    "programId": "<string>",
    "partnerId": "<string>",
    "prefix": "<string>",
    "trackConversion": True,
    "archived": True,
    "tagIds": ["clux0rgak00011..."],
    "tagNames": "<string>",
    "folderId": "<string>",
    "comments": "<string>",
    "expiresAt": "<string>",
    "expiredUrl": "<string>",
    "password": "<string>",
    "proxy": True,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "video": "<string>",
    "rewrite": True,
    "ios": "<string>",
    "android": "<string>",
    "geo": {},
    "doIndex": True,
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "ref": "<string>",
    "testVariants": [
        {
            "url": "https://example.com/variant-1",
            "percentage": 50
        },
        {
            "url": "https://example.com/variant-2",
            "percentage": 50
        }
    ],
    "testStartedAt": "<string>",
    "testCompletedAt": "<string>",
    "publicStats": True,
    "tagId": "<string>",
    "webhookIds": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://google.com',
    domain: '<string>',
    key: '<string>',
    keyLength: 96,
    externalId: '123456',
    tenantId: '<string>',
    programId: '<string>',
    partnerId: '<string>',
    prefix: '<string>',
    trackConversion: true,
    archived: true,
    tagIds: ['clux0rgak00011...'],
    tagNames: '<string>',
    folderId: '<string>',
    comments: '<string>',
    expiresAt: '<string>',
    expiredUrl: '<string>',
    password: '<string>',
    proxy: true,
    title: '<string>',
    description: '<string>',
    image: '<string>',
    video: '<string>',
    rewrite: true,
    ios: '<string>',
    android: '<string>',
    geo: {},
    doIndex: true,
    utm_source: '<string>',
    utm_medium: '<string>',
    utm_campaign: '<string>',
    utm_term: '<string>',
    utm_content: '<string>',
    ref: '<string>',
    testVariants: [
      {url: 'https://example.com/variant-1', percentage: 50},
      {url: 'https://example.com/variant-2', percentage: 50}
    ],
    testStartedAt: '<string>',
    testCompletedAt: '<string>',
    publicStats: true,
    tagId: '<string>',
    webhookIds: ['<string>']
  })
};

fetch('https://api.dub.co/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dub.co/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://google.com',
    'domain' => '<string>',
    'key' => '<string>',
    'keyLength' => 96,
    'externalId' => '123456',
    'tenantId' => '<string>',
    'programId' => '<string>',
    'partnerId' => '<string>',
    'prefix' => '<string>',
    'trackConversion' => true,
    'archived' => true,
    'tagIds' => [
        'clux0rgak00011...'
    ],
    'tagNames' => '<string>',
    'folderId' => '<string>',
    'comments' => '<string>',
    'expiresAt' => '<string>',
    'expiredUrl' => '<string>',
    'password' => '<string>',
    'proxy' => true,
    'title' => '<string>',
    'description' => '<string>',
    'image' => '<string>',
    'video' => '<string>',
    'rewrite' => true,
    'ios' => '<string>',
    'android' => '<string>',
    'geo' => [
        
    ],
    'doIndex' => true,
    'utm_source' => '<string>',
    'utm_medium' => '<string>',
    'utm_campaign' => '<string>',
    'utm_term' => '<string>',
    'utm_content' => '<string>',
    'ref' => '<string>',
    'testVariants' => [
        [
                'url' => 'https://example.com/variant-1',
                'percentage' => 50
        ],
        [
                'url' => 'https://example.com/variant-2',
                'percentage' => 50
        ]
    ],
    'testStartedAt' => '<string>',
    'testCompletedAt' => '<string>',
    'publicStats' => true,
    'tagId' => '<string>',
    'webhookIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/links"

	payload := strings.NewReader("{\n  \"url\": \"https://google.com\",\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"keyLength\": 96,\n  \"externalId\": \"123456\",\n  \"tenantId\": \"<string>\",\n  \"programId\": \"<string>\",\n  \"partnerId\": \"<string>\",\n  \"prefix\": \"<string>\",\n  \"trackConversion\": true,\n  \"archived\": true,\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": true,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"video\": \"<string>\",\n  \"rewrite\": true,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"doIndex\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"ref\": \"<string>\",\n  \"testVariants\": [\n    {\n      \"url\": \"https://example.com/variant-1\",\n      \"percentage\": 50\n    },\n    {\n      \"url\": \"https://example.com/variant-2\",\n      \"percentage\": 50\n    }\n  ],\n  \"testStartedAt\": \"<string>\",\n  \"testCompletedAt\": \"<string>\",\n  \"publicStats\": true,\n  \"tagId\": \"<string>\",\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dub.co/links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://google.com\",\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"keyLength\": 96,\n  \"externalId\": \"123456\",\n  \"tenantId\": \"<string>\",\n  \"programId\": \"<string>\",\n  \"partnerId\": \"<string>\",\n  \"prefix\": \"<string>\",\n  \"trackConversion\": true,\n  \"archived\": true,\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": true,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"video\": \"<string>\",\n  \"rewrite\": true,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"doIndex\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"ref\": \"<string>\",\n  \"testVariants\": [\n    {\n      \"url\": \"https://example.com/variant-1\",\n      \"percentage\": 50\n    },\n    {\n      \"url\": \"https://example.com/variant-2\",\n      \"percentage\": 50\n    }\n  ],\n  \"testStartedAt\": \"<string>\",\n  \"testCompletedAt\": \"<string>\",\n  \"publicStats\": true,\n  \"tagId\": \"<string>\",\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dub.co/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://google.com\",\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"keyLength\": 96,\n  \"externalId\": \"123456\",\n  \"tenantId\": \"<string>\",\n  \"programId\": \"<string>\",\n  \"partnerId\": \"<string>\",\n  \"prefix\": \"<string>\",\n  \"trackConversion\": true,\n  \"archived\": true,\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": true,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"video\": \"<string>\",\n  \"rewrite\": true,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"doIndex\": true,\n  \"utm_source\": \"<string>\",\n  \"utm_medium\": \"<string>\",\n  \"utm_campaign\": \"<string>\",\n  \"utm_term\": \"<string>\",\n  \"utm_content\": \"<string>\",\n  \"ref\": \"<string>\",\n  \"testVariants\": [\n    {\n      \"url\": \"https://example.com/variant-1\",\n      \"percentage\": 50\n    },\n    {\n      \"url\": \"https://example.com/variant-2\",\n      \"percentage\": 50\n    }\n  ],\n  \"testStartedAt\": \"<string>\",\n  \"testCompletedAt\": \"<string>\",\n  \"publicStats\": true,\n  \"tagId\": \"<string>\",\n  \"webhookIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "domain": "<string>",
  "key": "<string>",
  "url": "<string>",
  "trackConversion": false,
  "externalId": "<string>",
  "tenantId": "<string>",
  "programId": "<string>",
  "partnerId": "<string>",
  "archived": false,
  "expiresAt": "<string>",
  "expiredUrl": "<string>",
  "disabledAt": "<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>",
  "comments": "<string>",
  "shortLink": "<string>",
  "qrCode": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<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>",
  "webhookIds": [
    "<string>"
  ],
  "testVariants": [
    {
      "url": "https://example.com/variant-1",
      "percentage": 50
    },
    {
      "url": "https://example.com/variant-2",
      "percentage": 50
    }
  ],
  "testStartedAt": "<string>",
  "testCompletedAt": "<string>"
}

{
  "error": {
    "code": "bad_request",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#bad-request"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#forbidden"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#not-found"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#conflict"
  }
}

{
  "error": {
    "code": "invite_expired",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"
  }
}

{
  "error": {
    "code": "internal_server_error",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"
  }
}

Authorizations

Authorization

string

header

required

Default authentication mechanism

Body

application/json

url

string

required

The destination URL of the short link.

Maximum string length: 32000

Example:

"https://google.com"

domain

string

The domain of the short link (without protocol). If not provided, the primary domain for the workspace will be used (or dub.sh if the workspace has no domains).

Maximum string length: 190

key

string

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

Maximum string length: 190

keyLength

integer

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. Pass null or an empty string to remove it.

Maximum string length: 190

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. Pass null or an empty string to remove it.

Maximum string length: 190

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. Pass null or an empty string to remove the partner. Removing the partner also removes the program association.

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.

Maximum string length: 190

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.

Maximum string length: 32000

password

string | null

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

Maximum string length: 190

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.

Maximum string length: 32000

android

string | null

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

Maximum string length: 32000

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.

Show child attributes

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.

Maximum string length: 255

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.

Maximum string length: 255

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.

Maximum string length: 255

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.

Maximum string length: 255

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.

Maximum string length: 255

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.

Maximum string length: 255

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

Show child attributes

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.

webhookIds

string[] | null

deprecated

Deprecated: You can now enable link.clicked webhooks for all links in a workspace or folder without passing this field manually. An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.

Response

The created link

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

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.

disabledAt

string | null

required

The date and time when the short link was disabled. When a short link is disabled, it will redirect to its domain's not found URL, and its stats will be excluded from your overall stats.

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.

Show child attributes

publicStats

boolean

default:false

required

Whether the short link's stats are publicly accessible.

DUB API

SDKs

DUB PARTNERS API

DUB LINKS API

Create a link

Authorizations

Body

Response