Skip to main content
POST
Create a shortlink

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