Skip to main content
POST
Update a Dynamic Link template

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

application/x-www-form-urlencoded
template_id
string
required

The Dynamic Link Template's stable identifier. Server-generated on create; used as the lookup key on update and delete.

template_name
string

Human-readable template name. Required, and unique within the organization.

domain
string

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

destination_url
string

The URL the link sends visitors to.

apple_behaviour
string

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

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.

apple_custom_url
string

Custom iOS fallback URL used when apple_no_app_behaviour is custom.

android_behaviour
string

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

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.

android_custom_url
string

Custom Android fallback URL used when android_no_app_behaviour is custom.

is_default
string

Whether this domain is the organization's default for its link-usage class. Set via mark_default, not on create.

new_template_id
string

Update-only guard: if sent it must equal template_id, since template IDs are immutable.

Response

Success.

data
object

The endpoint's payload.