Create a Quick Link URL

Updated on Mar 20, 2025
Published on Feb 25, 2025

Post

/url

This endpoint is used to generate a Deep Link URL based on the parameters provided.

Body parameters

Expand All

object

branch_key

string Required

The Branch Key of the originating app, found in the Settings tab of your Branch Dashboard.

Examplekey_live_xxxx

channel

string

Deep link channel

Examplefacebook

feature

string

Deep link feature set

Exampleonboarding

campaign

string

Campaign name

Examplenew product

stage

string

Examplenew user

tags

Array of string

Social media tags

string

Exampleone

type

integer

Set to 2 in order to see Branch Deep Link URLs in the Branch Dashboard (must also set $marketing_title).

Example2

data

object

$marketing_title

string

Set the marketing title to see the URL in the Dashboard (must also set type to 2).

Examplemytitle

$fallback_url

string

Change the redirect endpoint for all platforms - so you don't have to enable it by platform. Note that Branch will forward all robots to this URL, which overrides any OG tags entered in the link. System-wide Default URL (set in Link Settings)

Example

$fallback_url_xx

string

Change the redirect endpoint for all platforms based on a lower-case Alpha-2 country code.

Example

$desktop_url

string

Redirect URL for desktop devices - mobile users will default to the app store.

Example

$ios_url

string

Change the redirect endpoint for iOS App Store page for your app (set in Link Settings)

Example

$ios_url_xx

string

Change the redirect endpoint for iOS based on a lower-case Alpha-2 country code. For example, $ios_url_de="..." would redirect Germany deep link clicks.

Example

$ipad_url

string

Change the redirect endpoint for iPads $ios_url value

Example

$android_url

string

Change the redirect endpoint for Android Play Store page for your app (set in Link Settings)

Example

$android_url_xx

string

Change the redirect endpoint for Android based on a lower-case Alpha-2 country code. For example, $android_url_de="..." would redirect Germany deep link clicks.

Example

$samsung_url

string

Redirect to Samsung Galaxy Store on Samsung devices. Only link level control. Format should be http://www.samsungapps.com/appquery/appDetail.as?appId={PACKAGE_NAME_HERE}

Example

$huawei_url

string

Redirect to the Huawei App Gallery on Huawei devices. Only link level control. Format should be https://appgallery.huawei.com/app/{HUAWEI_APP_GALLERY_ID_HERE}

Example

$windows_phone_url

string

Change the redirect endpoint for Windows OS Windows Phone default URL (set in Link Settings)

Example

$blackberry_url

string

Change the redirect endpoint for Blackberry OS BlackBerry default URL (set in Link Settings) Deep link channel

Example

$fire_url

string

Change the redirect endpoint for Amazon Fire OS Fire default URL (set in Link Settings)

Example

$ios_wechat_url

string

Change the redirect endpoint for WeChat on iOS devices $ios_url value

Example

$android_wechat_url

string

Change the redirect endpoint for WeChat on Android devices $android_url value

Example

$web_only

boolean

Force to open the $fallback_url instead of the app

ExampleFalse

$desktop_web_only

boolean

Force to open the $windows_desktop_url, $mac_desktop_url, $desktop_url, or $fallback_url in this order of precedence instead of the app

ExampleFalse

$mobile_web_only

boolean

Force to open the$ios_url, $android_url, or $fallback_url in this order of precefdence instead of the app

ExampleFalse

$after_click_url

string

When a user returns to the browser after going to the app, take them to this URL. iOS only; Android coming soon

ExampleFalse

$afterclick_desktop_url

boolean

When a user on desktop returns to the desktop browser after going to the desktop app, take them to this URL.

ExampleFalse

alias

string

Instead of our standard encoded short url, you can specify the vanity alias. For example, instead of a random string of characters/integers, you can set the vanity alias as .app.link/devonaustin.

Example

duration

integer

In seconds. Only set this key if you want to override the match duration for deep link matching. This is the time that Branch allows a click to remain outstanding and be eligible to be matched with a new app session. This is default set to 7200 (2 hours).

Example7200

analytics

object

~channel

string

Use channel to tag the route that your link reaches users. For example, tag links with 'Facebook' or 'LinkedIn' to help track clicks and installs through those paths separately

Example

~feature

string

This is the feature of your app that the link might be associated with. For example, if you had built a referral program, you would label links with the feature 'referral'

Example

~campaign

string

Use this field to organize the links by actual campaign. For example, if you launched a new feature or product and want to run a campaign around that

Example

~campaign_id

string

Use this field to organize the links by actual campaign id. For example, if you launched a new feature or product and want to run a campaign around that

Example

~customer_campaign

string

The customer campaign specified for the last attributed touch. can be specified on links by the client.

Example

~stage

string

Use this to categorize the progress or category of a user when the link was generated. For example, if you had an invite system accessible on level 1, level 3 and 5, you could differentiate links generated at each level with this parameter

Example

~tags

Array of string

This is a free form entry with unlimited values ['string']. Use it to organize your link data with labels that don't fit within the bounds of the above

string

~secondary_publisher

string

secondary publisher specified for the last attributed touch. passed by the ad network.

Example

~customer_secondary_publisher

string

The ID of the secondary publisher specified for the last attributed touch. can be specified on links by the client.

Example

~creative_name

string

The creative name specified for the last attributed touch.

Example

~creative_id

string

The creative ID specified for the last attributed touch.

Example

~ad_set_name

string

The ad set name specified for the last attributed touch.

Example

~ad_set_id

string

The ad set ID specified for the last attributed touch.

Example

~customer_ad_set_name

string

The customer ad set name specified for the last attributed touch. can be specified on links by the client.

Example

~ad_name

string

The ad name specified for the last attributed touch.

Example

~ad_id

string

The ad ID specified for the last attributed touch.

Example

~customer_ad_name

string

The customer ad name specified for the last attributed touch. can be specified on the link by the client.

Example

~keyword

string

The keyword specified for the last attributed touch.

Example

~keyword_id

string

The unique ID for keyword of the last touch

Example

~customer_keyword

string

The customer keyword of the last touch. Can be specified on links by the client.

Example

~placement

string

The placement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns.

Example

~placement_id

string

The ID of placement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns.

Example

~customer_placement

string

The customer specified placement of the last touch, as set with an analytics tag. Actual app or website the ad appears on display campaigns. Can be specified on the link by the client.

Example

~sub_site_name

string

Reference to the site where the ad was displayed.

Example

~customer_sub_site_name

string

Customer reference to the site where the ad was displayed. Can be specified on links by the client.

Example

Responses

200

object

url

string

Generated URL

Examplehttps://example.app.link/{UNIQUE_PATH_HERE}

400

Authentication Failed

Result

"{\n    \"error\": {\n        \"message\": \"Authentication failed !\",\n        \"code\": 400\n    }\n}"

Expand All

object

error

object (inline_response_400_error)

message

string

ExampleAuthentication failed !

code

integer

Example400

429

Rate Limit Reached

Result

"{\n    \"error\": {\n        \"code\": 429,\n        \"message\": \"Rate limit reached.\"\n    }\n}"

Expand All

object

error

object (inline_response_400_error)

message

string

ExampleAuthentication failed !

code

integer

Example400

Was this article helpful?

Create a Quick Link URL

Shortcuts

Company

Resources