Skip to main content
POST
/
api
/
v1
/
shortlinks
/
create_shortlink
Create a shortlink
curl --request POST \
  --url https://dashlink.ai/api/v1/shortlinks/create_shortlink \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'destination_url=<string>' \
  --form 'domain=<string>' \
  --form 'title=<string>' \
  --form 'back_half=<string>' \
  --form utm_analytics_enabled=false \
  --form 'utm_campaign=<string>' \
  --form 'utm_term=<string>' \
  --form 'utm_medium=<string>' \
  --form 'utm_content=<string>' \
  --form 'utm_source=<string>' \
  --form 'utm_id=<string>' \
  --form is_custom_preview=false \
  --form 'preview_title=<string>' \
  --form 'preview_description=<string>' \
  --form preview_image='@example-file' \
  --form qr_code_enabled=false \
  --form 'qr_code_color=<string>'
import requests

url = "https://dashlink.ai/api/v1/shortlinks/create_shortlink"

files = { "preview_image": ("example-file", open("example-file", "rb")) }
payload = {
"destination_url": "<string>",
"domain": "<string>",
"title": "<string>",
"back_half": "<string>",
"utm_analytics_enabled": "false",
"utm_campaign": "<string>",
"utm_term": "<string>",
"utm_medium": "<string>",
"utm_content": "<string>",
"utm_source": "<string>",
"utm_id": "<string>",
"is_custom_preview": "false",
"preview_title": "<string>",
"preview_description": "<string>",
"qr_code_enabled": "false",
"qr_code_color": "<string>"
}
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('destination_url', '<string>');
form.append('domain', '<string>');
form.append('title', '<string>');
form.append('back_half', '<string>');
form.append('utm_analytics_enabled', 'false');
form.append('utm_campaign', '<string>');
form.append('utm_term', '<string>');
form.append('utm_medium', '<string>');
form.append('utm_content', '<string>');
form.append('utm_source', '<string>');
form.append('utm_id', '<string>');
form.append('is_custom_preview', 'false');
form.append('preview_title', '<string>');
form.append('preview_description', '<string>');
form.append('preview_image', '<string>');
form.append('qr_code_enabled', 'false');
form.append('qr_code_color', '<string>');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://dashlink.ai/api/v1/shortlinks/create_shortlink', 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://dashlink.ai/api/v1/shortlinks/create_shortlink",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"destination_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"domain\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"back_half\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_analytics_enabled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_campaign\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_term\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_medium\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_content\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_source\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_custom_preview\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"qr_code_enabled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"qr_code_color\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-API-Key: <api-key>"
],
]);

$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://dashlink.ai/api/v1/shortlinks/create_shortlink"

payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"destination_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"domain\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"back_half\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_analytics_enabled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_campaign\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_term\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_medium\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_content\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_source\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_custom_preview\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"qr_code_enabled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"qr_code_color\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

req.Header.Add("X-API-Key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://dashlink.ai/api/v1/shortlinks/create_shortlink")
.header("X-API-Key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"destination_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"domain\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"back_half\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_analytics_enabled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_campaign\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_term\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_medium\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_content\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_source\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_custom_preview\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"qr_code_enabled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"qr_code_color\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dashlink.ai/api/v1/shortlinks/create_shortlink")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"destination_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"domain\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"back_half\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_analytics_enabled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_campaign\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_term\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_medium\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_content\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_source\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"utm_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_custom_preview\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"qr_code_enabled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"qr_code_color\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "data": {
    "status": "success",
    "message": "Shortlink created successfully.",
    "shortlink": {
      "name": "<string>",
      "destination_url": "<string>",
      "shortlink_url": "<string>",
      "title": "<string>",
      "is_custom_preview": true,
      "preview_title": "<string>",
      "preview_description": "<string>",
      "preview_image": "<string>",
      "qr_code_enabled": true
    }
  }
}
{
"error": {
"message": "<string>",
"status_code": 123,
"code": "<string>",
"details": {}
}
}
{
"error": {
"message": "<string>",
"status_code": 123,
"code": "<string>",
"details": {}
}
}
{
"error": {
"message": "<string>",
"status_code": 123,
"code": "<string>",
"details": {}
}
}
{
"error": {
"message": "<string>",
"status_code": 123,
"code": "<string>",
"details": {}
}
}
{
"error": {
"message": "<string>",
"status_code": 123,
"code": "<string>",
"details": {}
}
}
{
"error": {
"message": "<string>",
"status_code": 123,
"code": "<string>",
"details": {}
}
}

Authorizations

X-API-Key
string
header
required

Body

multipart/form-data
destination_url
string<uri>
required

Target URL the shortlink will redirect to.

domain
string
required

Dashlink Domain document name (ID). The effective hostname is taken from the Dashlink Domain.domain_name field.

title
string

Human-readable title for the shortlink.

back_half
string

Custom back-half path segment, e.g. summer-sale. If omitted, the system auto-generates a unique code per domain.

utm_analytics_enabled
string
default:false

Whether UTM analytics are enabled (true/false).

utm_campaign
string
utm_term
string
utm_medium
string
utm_content
string
utm_source
string
utm_id
string
is_custom_preview
string
default:false

Whether custom preview metadata/image are used (true/false).

preview_title
string
preview_description
string
preview_image
file

Custom preview image file. Allowed extensions: jpeg, jpg, png, svg. Max size: 500KB.

qr_code_enabled
string
default:false

Whether to generate a QR code (true/false).

qr_code_color
string

HEX color value used for the QR code (e.g. #FF7908).

Response

Shortlink created successfully.

data
object
required