Create QR Code

Published on Feb 25, 2025

Post

/qr-code

This endpoint provides a consumer to create creating custom QR Codes programmatically. Every QR Code will contain a unique Branch link which you can deep link and track analytics with.

Body parameters

Collapse all

object

branch_key

string Required

The Branch key of the originating app; from your Branch Settings Dashboard i.e. accessible over https://dashboard.branch.io/account-settings/app. Please note that the key provided in example is dummy.

Examplekey_live_xxxx

qr_code_settings

object Required

Pre-defined set of QR code related properties that works over the overall display of the QR Code

image_format

string

The output image format that could be either JPEG or PNG

Valid values[ "png", "jpeg", "jpg" ]

Examplepng

center_logo_url

string

URL to the image you want as a center logo e.g. “https://cdn.branch.io/branch-assets/00000000-og_image.png”

Examplehttps://cdn.branch.io/branch-assets/00000000-og_image.png

width

integer

Output size of QR Code image. Min 300px. Max 2000px. (Only applicable to JPEG/PNG)

Minimum300

Maximum2000

Example300

margin

integer

The number of pixels you want for the margin. Min 1px. Max 20px.

Minimum1

Maximum20

Example1

code_color

string

Hex color value of the QR Code itself as per the https://htmlcolorcodes.com/

Example#000000

background_color

string

Hex color value of the background of the QR code itself as per the https://htmlcolorcodes.com/

Example#FFFFFF

code_pattern

integer

Instead of the generic/standard QR-Code pattern we’re used to seeing, customers can now use (1) standard, (2) squares, (3) circles, (4) triangles, (5) diamonds, (6) hexagons, and (7) octagons.

Valid values[ 1, 2, 3, 4, 5, 6, 7 ]

Default1

finder_pattern

string

The finder pattern refers to the shape seen in the top left, top right, and bottom left of a QR-Code. Users can now choose between a square, a rounded square, or a circle. 1 = square, 2 = rounded rectangle, 3 = circle

Valid values[ "1", "2", "3" ]

Default"1"

finder_pattern_color

string

Hex color value of the Finder Pattern as per the https://htmlcolorcodes.com/

Example#00A3D8

background_image_url

string

We can lay the QR-Code on top of a background image.

code_pattern_url

string

Direct link to an image to be used as the code-pattern itself on the QR Code.

finder_eye_color

string

Hex color value of the finder eye as per the https://htmlcolorcodes.com/

Example#00A3D8

data

object

The dictionary to embed link data behind the QR Code. Accessed as session or install parameters from the SDK. Use the data dictionary for all link control parameters that you'll find here https://help.branch.io/using-branch/docs/creating-a-deep-link#section-redirections.

$click_install_window_days

string

Time between a click or a web to app auto redirect and an install or reinstall (i.e., https://branchster.app.link/{UNIQUE_ID_HERE}?$click_install_window_days=3

Example

$click_session_start_window_days

string

Time between a click or a web to app auto redirect and an open or web session start. (i.e., https://branchster.app.link/{UNIQUE_ID_HERE}?$click_session_start_window_days=7)

Example

$click_conversion_window_days

string

Time between a click or a web to app auto redirect and a conversion event. Conversion events include commerce events (e.g. purchase, add to cart), all custom events, and all view events like pageviews & content views. (i.e., https://branchster.app.link/{UNIQUE_ID_HERE}?$click_session_start_window_days=30)

Example

$impression_install_window_days

string

Time between an ad impression and an install or reinstall. (i.e., https://branchster.app.link/{UNIQUE_ID_HERE}?$impression_install_window_days=3)

Example

$impression_conversion_window_days

string

Time between an ad impression and a conversion event. Conversion events include commerce events (e.g. purchase, add to cart), all custom events, and all view events like pageviews & content views. (i.e., https://branchster.app.link/{UNIQUE_ID_HERE}?$impression_session_start_window_days=7)

Example

$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 lower-case Alpha-2 country code. For example, $fallback_url_de="..." would redirect Germany deep link clicks. You should also set $fallback_url to act as the global redirect in addition to the countr -specific ones. WARNING: platform specific redirects (like $ios_url or $desktop_url) are set, they will override the country-specific redirect. Thus, the recommendation is to only use $fallback_url_xx for the country specific redirects and $fallback_url to catch all other users.

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 (https://www.iso.org/obp/ui/#search). For example, $ios_url_de="..." would redirect Germany deep link clicks. You should also set $ios_url to act as the global redirect in addition to the country-specific ones.

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 (https://www.iso.org/obp/ui/#search). For example, $android_url_de="..." would redirect Germany deep link clicks. You should also set $android_url to act as the global redirect in addition to the country-specific ones.

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)

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

Example

$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

Example

$mobile_web_only

boolean

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

Example

$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

Example

$afterclick_desktop_url

string

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

Example

$uri_redirect_mode

integer

0: This is the default value that yields the standard behavior where we don't try to open the app if the user can see an error.
1: Smart redirect mode. Same behavior as 0 until we know the user has the app installed through Branch persona data. In that case, force URI schemes to open the app.
2: Forceful redirect mode. Always try to force open the app, even if it risks showing an error message when the app is not installed.

Valid values[ 0, 1, 2 ]

Example0

$deeplink_path

string

Set the deep link path for all platforms - so you don't have to enable it by platform. When the Branch SDK receives a link with this parameter set, it will automatically load the custom URI path contained within

Example

$android_deeplink_path

string

Set the deep link path for Android apps. When the Branch SDK receives a link with this parameter set, it will automatically load the custom Android URI path contained within

Example

$ios_deeplink_path

string

Set the deep link path for iOS apps. When the Branch SDK receives a link with this parameter set, it will automatically load the custom iOS URI path contained within

Example

$ios_nativelink

boolean

Set to true to make the link route to a NativeLink™ used for enabling deferred deep linking on iOS 15+ & Private Relay. Can also be set to a deepview/template key to manually trigger the launch of a specific NativeLink™ deepview.

Example

$desktop_deeplink_path

string

Set the deep link path for Desktop apps. You will have to fetch this parameter and route the user accordingly

Example

$match_duration

integer

Lets you control the snapshotting match timeout (the time that a click will wait for an app open to match) also known as attribution window. Specified in seconds

Example

$always_deeplink

boolean

Set to false to make links always fall back to your mobile site. Does not apply to Universal Links or Android App Links.

Example

$ios_redirect_timeout

integer

Control the timeout that the client-side JS waits after trying to open up the app before redirecting to the App Store. Specified in milliseconds

Example

$android_redirect_timeout

integer

Control the timeout that the client side JS waits after trying to open up the app before redirecting to the Play Store. Specified in milliseconds

Example

$custom_sms_text

string

Text for SMS link sent for desktop clicks to this link. Must contain {{ link }} Value of Text me the app page in Settings

Example

$marketing_title

string

Set the marketing title for the deep link.

Example

$deeplink_no_attribution

boolean

Set to true for the links to only support deep linking without any attribution for that link.

Example

$publicly_indexable

integer

Cannot modify here. Needs to be set by the Branch Universal Object

Example

$canonical_identifier

string

This is the unique identifier for content that will help Branch dedupe across many instances of the same thing. Suitable options: a website with pathing, or a database with identifiers for entities

Examplecontent/123

$canonical_url

string

This is the url set against the identifier

Examplehttp://www.example.com/content/123

$content_type

string

This is a label for the type of content present. Apple recommends that you use uniform type identifier as described here

Example

$do_not_process

boolean

Lets you control the snapshotting match timeout (the time that a click will wait for an app open to match) also known as attribution window. Specified in seconds

Example

$ios_deepview

string

The name of the deepview template to use for iOS

Example

$android_deepview

string

The name of the deepview template to use for Android

Example

$desktop_deepview

string

The name of the deepview template to use for the Desktop

Example

$ios_passive_deepview

string

The name of the template to use for iOS.

Example

$android_passive_deepview

string

The name of the template to use for Android.

Example

$desktop_passive_deepview

string

The name of the template to use for Desktop.

Example

$og_title

string

Set the title of the link as it will be seen in social media displays

ExampleTitle from Deep Link

$og_description

string

Set the description of the link as it will be seen in social media displays

ExampleDescription for QR code

$og_image_url

string

Set the image of the link as it will be seen in social media displays

Examplehttp://www.lorempixel.com/400/400/

$og_image_width

integer

Set the image's width in pixels for social media displays

Example

$og_image_height

integer

Set the image's height in pixels for social media displays

Example

$og_video

string

Set a video as it will be seen in social media displays

Example

$og_url

string

Set the base URL of the link as it will be seen in social media displays

Example

$og_type

string

Set the type of custom card format link as it will be seen in social media displays. Don't set this property when sharing deep links on Facebook

Example

$og_redirect

string

(Advanced, not recommended) Set a custom URL that we redirect the social media robots to in order to retrieve all the appropriate tags

Example

$og_app_id

string

(Rarely used) Sets the app id tag

Example

$twitter_card

string

Set the Twitter card type of the link (e.g. player) (you must whitelist your deep link with the Twitter Card Validator

Example

$twitter_title

string

Set the title of the Twitter card

Example

$twitter_description

string

Set the description of the Twitter card

Example

$twitter_image_url

string

Set the image URL for the Twitter card

Example

$twitter_site

string

Set the site for Twitter

Example

$twitter_app_country

string

Set the app country for the app card

Example

$twitter_player

string

Set the video player's URL. Defaults to the value of $og_video.

Example

$twitter_player_width

integer

Set the player's width in pixels

Example

$twitter_player_height

integer

Set the player's height in pixels

Example

$custom_meta_tags

string

Valid stringified JSON dictionary of the tags’ keys and values

Example

random

string

Any key-value pair

Example

custom_data

string

Any key-value pair

Example

custom_string

string

Any key-value pair

ExampleAny data

any_value

string

Any key-value pair

Example

look_at

string

Any key-value pair

Example

nav_here

string

Any key-value pair

Example

Responses

200

400

Was this article helpful?

Create QR Code

Shortcuts

Company

Resources