Skip to main content
POST
Update a Shortlink

Authorizations

X-API-Key
string
header
required

Your API key, for example dlk_live_.... Create one in the dashboard under Settings → API Keys. Keys are shown once at creation and stored only as a hash, so they cannot be recovered.

Body

multipart/form-data
name
string
required

The resource identifier.

back_half
string

The path after the domain. Generated at random when omitted.

destination_payload
string

JSON object holding the type-specific fields the destination is built from (for example a url key, or the wifi/sms/call/email/vcard fields). Required for non-url destination types.

destination_type
string

The kind of destination to build: url, wifi, sms, call, email or vcard. Defaults to url.

destination_url
string

The URL the link sends visitors to.

domain
string

The domain to build the link on. Uses your default domain when omitted.

dynamic_routing_enabled
string

Whether routing_rules are evaluated for this link. When off, the base destination is always served. Defaults to false.

expiration_url
string

URL to redirect visitors to once the link has expired. Optional.

expires_at
string

ISO-8601 timestamp after which the link expires. Must include a timezone (Z or an offset).

is_custom_preview
string

Whether the link uses custom link-preview metadata (preview_title, preview_description, preview_image) instead of an auto-generated preview. Defaults to false.

Whether the link stops resolving after expires_at. Defaults to false.

password
string

Password required to open the link.

password_protected
string

Whether the link requires a password.

preview_description
string

Custom link-preview description shown when the link is shared.

preview_title
string

Custom link-preview (Open Graph) title shown when the link is shared.

qr_code_color
string

Convenience hex color applied to both the QR pattern and the corner eyes when a link's QR code is generated. Defaults to #000000.

qr_code_enabled
string

Whether to generate a QR code for this link. Defaults to false.

routing_rules
string

Ordered JSON array (max 10) of conditional destination overrides; the first rule whose condition matches wins. Each rule carries a destination_type/destination_payload and a condition tree over properties such as req.country, agent.os or calendar.weekday.

title
string

Human-readable name shown in the dashboard.

utm_analytics_enabled
string

Whether UTM parameters are appended to the destination and tracked. Defaults to false.

utm_campaign
string

utm_campaign value appended to the destination URL.

utm_content
string

utm_content value appended to the destination URL.

utm_id
string

utm_id value appended to the destination URL.

utm_medium
string

utm_medium value appended to the destination URL.

utm_source
string

utm_source value appended to the destination URL.

utm_term
string

utm_term value appended to the destination URL.

preview_image
file

Custom link-preview image. Sent as an uploaded file; returned as a URL.

Response

Success.

data
object

The endpoint's payload.