Create a Deep Link URL

  • Published on Feb 25, 2025
Post
/url

This endpoint is used to generated 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 obtained in your Account Settings

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

Default is 0

Example0
data
object
$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
$canonical_url
string

This is the url set against the identifier.

Examplehttp://www.example.com/content/123
$deeplink_path
string

The value of the deep link path that you would like us to append to your URI.

Exampleradio/station/456
$og_title
string

Set the title of the Deep Link as it will be seen in social media displays.

ExampleDeep Link title.
$og_description
string

Set the description of the Deep Link as it will be seen in social media displays.

ExampleDeep Link description.
$og_image_url
string

Set the image of the Deep Link as it will be seen in social media displays.

Examplehttp://www.lorempixel.com/400/400/
~id
string

The unique ID for the link.

Example00000001
~creation_source
string

The source where the Branch Deep Link was created, represented by a number.

Example1
~tags
Array of string

A free form entry with unlimited values of type string. Use it to organize your link data with labels that don't fit under other keys.

string
Exampletag_one
~campaign
string

The name of the campaign associated with your link.

Examplefall_feature_launch
~campaign_id
string

The ID for the campaign associated with your link.

Exampledata_campaign_0000
~channel
string

The route that your link reaches your users by.

ExampleLinkedIn
~feature
string

The feature of your app associated with the link.

Examplereferral
~stage
string

The progress or category of a user when the link was generated.

Examplelevel 5
~marketing
string

Pass "true" to indicate this is a Quick Link.

ExampleTrue
~link_type
string

The Branch link type (Deep, Quick, or Ad).

ExampleQuick
~agency_id
string

The ID of the relevant agency.

Example1111
~quick_link_template_id
string

The ID of the Branch Quick Link template you are using.

Example1010
~ad_link_template_id
string

The ID of the ad link template you are using.

Example0101
~advertising_partner_name
string

The name of the relevant advertising partner.

ExampleFacebook
~creative_name
string

The creative name specified for the last attributed touch.

Examplefall_feature_facebook
~customer_placement
string

The customer specified placement of the last touch. This is the actual app or website that the ad appears on display campaigns.

Examplecompany_ios_app
~ad_set_name
string

The ad set name specified for the last attributed touch.

Examplead_group_name
~ad_set_id
string

The ad set ID specified for the last attributed touch.

Examplead_group_id
~branch_ad_format
string

Possible values are "Cross-Platform Display" or "App Only".

ExampleCross-Platform Display
~secondary_ad_format
string

Specify an ad format to help organize your analytics and make it faster to set up web fallbacks for your link.

ExampleApp Only
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
Responses
200

Ok

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