Skip to main content
POST
Update an app dynamic link

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.

android_behaviour
string

What an Android tap does: app (open the app) or browser (go to the web destination). Required for dynamic links.

android_custom_url
string

Custom Android fallback URL used when android_no_app_behaviour is custom.

android_intent_url
string

Android deep link to open when android_behaviour is app — a custom scheme (myapp://…) or an https URL.

android_no_app_behaviour
string

Android fallback when the app is not installed: store or custom.

android_store_url
string

Play Store URL used when android_no_app_behaviour is store.

apple_behaviour
string

What an iOS tap does: app (open the app) or browser (go to the web destination). Required for dynamic links.

apple_custom_url
string

Custom iOS fallback URL used when apple_no_app_behaviour is custom.

apple_intent_url
string

iOS deep link to open when apple_behaviour is app — a custom scheme (myapp://…) or an https URL.

apple_no_app_behaviour
string

iOS fallback when the app is not installed: store or custom.

apple_store_url
string

App Store URL used when apple_no_app_behaviour is store.

back_half
string

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

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.

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.

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.