Update Branch App Config

Prev
Put
/app/{branch_key}

This endpoint is used updated the existing branch app configurations. All parameters passed within the request body will be updated as per the value provided.

Path parameters
branch_key
stringRequired

The Branch Key of the originating app obtained in your Account Settings

Examplekey_live_xxxx
Body parameters
Expand All
object
branch_secret
string Required

The Branch Secret of the originating app obtained in your Account Settings

Examplesecret_live_xxxx
dev_email
string Required

The main contact developer email (max 255 characters).

Pattern^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
always_open_app
integer

Indicates whether to try to open the app on link click or not

Valid values[ 0, 1 ]
Minimum0
Maximum1
android_app
integer

Whether an Android app is enabled. 0 is for disabled. 1 is for enabled.

Valid values[ 0, 1 ]
Minimum0
Maximum1
android_app_links_enabled
boolean

whether App Links are enabled

Valid values[ "True", "False" ]
ExampleFalse
android_cd_enabled
boolean

Indicate if CD [Content Discovery] is enabled for Android

Example
android_cd_hashed
string

Android CD hash details

Example
android_tablet_url
string

URL specific to Android tablets

Example
auto_fetch
boolean

Details auto fetching flag

Example
deepview_configs
object

Android & iOS configurations related to deep views

ios
object

iOS related deep view configurations

enabled
boolean

Indicate iOS related configurations are enabled

ExampleTrue
clipboard_deepview
string

Deepview details

Examplebranch_clipboard_deepview
deepview_audience_id
integer

Unique deepview id

Example0
android
object

Android related deep view configurations

enabled
boolean

Indicate Android related configurations are enabled

ExampleTrue
clipboard_deepview
string

Deepview details

Examplebranch_clipboard_deepview
deepview_audience_id
integer

Unique deepview id

Example0
default_short_url_domain
string

Short URL to the default domain

Examplebranch.app.link
desktop_uri_scheme
string

Standard URI scheme if available

Example
esp_config
object

Specific configurations for email service providers

map_query_params_to_deep_link_data
Array of string
string
secrets
Array of string
string
strip_protocol_from_deeplink_path
boolean
ExampleFalse
email_enabled
boolean
ExampleFalse
strip_protocol_from_android_deeplink_path
boolean
ExampleFalse
default_to_open_for_android_deeplink_path
boolean
ExampleFalse
append_full_url_for_key
string
Examplehttps://example.com/sample-page/
append_all_params
boolean
ExampleTrue
ads_enabled
boolean
ExampleFalse
append_path_for_key
string
Example
strip_protocol_from_ios_deeplink_path
boolean
ExampleFalse
has_confirmed
boolean
ExampleTrue
imei_collection_enabled
boolean

Indicate if IMEI collection is enabled

Example
imei_terms_and_conditions
string

IMEI terms and condition if available

Example
ios_bundle_settings
string

iOS settings

Example
ios_additional_bundle_ids
Array of string

Additional ios bundle ids

string
Examplecom.test
ios_cd_enabled
boolean

Indicate if CD [Content Discovery] is enabled for iOS

Example
ios_cd_hashed
string

iOS CD hash details

Example
ipad_url
string

Ipad URL associated with the request

Example
ios_app_store_id
string

Application id specific to iOS

Example
map_utm_params
string
Example
reserved_analytics_to_utm
string
Example
origin
string

Request origin

Example
sitemap_enabled
string

Indicate if CD [Content Discovery] is enabled for Android

Example
wechat_url
string

Wechat URL against the request

Example
redirect_domains_whitelist
Array of string

Whitelist urls for redirection

string
Example
journeys_open_app
string
Example
passive_deepview_ios
string
Example
passive_deepview_android
string
Example
uri_redirect_mode
integer

URI redirection mode

Example1
timezone
string

Request timezone

ExampleAmerica/Los_Angeles
mac_uri_scheme
string

MAC uri scheme

Examplebranch-example-mac
mac_store_url
string

Mac Store valid URL if avialable

Example
windows_uri_scheme
string
Exampleexamplebranchsdk
windows_store_url
string

Windows Store valid URL if avialable

Example
windows_package_family_name
string
Example
ios_app_store_id_verified
boolean

Identifies if the ios app store id is verified officially

Example
organic_search_domains
Array of string

Search domains

string
Example
creation_date
string

Date app was created

Example2019-06-19T19:37:31.887Z
app_name
string

Name of the app

ExampleMy App Name
dev_name
string

Main contact name

ExampleFirst Last
dev_phone_number
string

Main contact phone

Example
android_url
string

url of Android store, or namespace (com.android.myapp)

Example
android_uri_scheme
string

the Android URI scheme

Example
android_package_name
string

the Android package name

Example
sha256_cert_fingerprints
Array of string

The SHA256 fingerprints for App Links

string
ios_app
integer

whether an iOS app is enabled

Example0
ios_url
string

Url of iOS store, or app id (id00000000)

Example
ios_uri_scheme
string

The iOS URI scheme

Example
ios_store_country
string

The country code of the app, default to US

ExampleUS
ios_bundle_id
string

The iOS bundle ID

Examplecom.test.app
ios_team_id
string

The iOS Team ID

Example0000XXXX
universal_linking_enabled
string

whether Universal Links are enabled

Example
fire_url
string

the redirect on Fire phones

Example
windows_phone_url
string

the redirect on Windows phones

Example
blackberry_url
string

The redirect on Blackberry phones

Example
web_url
string

backup website if URLs are null

Examplehttps://branch.io
default_desktop_url
string

the default desktop redirect, or null if set to hosted SMS

Examplehttp://branch.io
text_message
string

text message to use, {{ link }} will be replaced with short link

Example
og_app_id
string

optional default Open Graph (OG) app id

Example
og_title
string

optional default OG title

ExampleBranch Monster Factory
og_image_url
string

optional default OG image URL

Example
og_description
string

optional default OG description

Example
deepview_desktop
string

the current deepview selected for the desktop platform

Example
deepview_ios
string

the current deepview selected for the iOS platform

Example
deepview_android
string

the current deepview selected for the Android platform

Example
Responses
200

Ok

Expand All
object
alternate_short_url_domain
string

An alternative short URL to the domain

Examplebranch-alternate.app.link
always_open_app
integer

Indicates whether to try to open the app on link click or not

Example1
android_cd_enabled
boolean

Indicate if CD [Content Discovery] is enabled for Android

Example
android_cd_hashed
string

Android CD hash details

Example
android_tablet_url
string

URL specific to Android tablets

Example
auto_fetch
boolean

Details auto fetching flag

Example
deepview_configs
object

Android & iOS configurations related to deep views

ios
object

iOS related deep view configurations

enabled
boolean

Indicate iOS related configurations are enabled

ExampleTrue
clipboard_deepview
string

Deepview details

Examplebranch_clipboard_deepview
deepview_audience_id
integer

Unique deepview id

Example0
android
object

Android related deep view configurations

enabled
boolean

Indicate Android related configurations are enabled

ExampleTrue
clipboard_deepview
string

Deepview details

Examplebranch_clipboard_deepview
deepview_audience_id
integer

Unique deepview id

Example0
default_short_url_domain
string

Short URL to the default domain

Examplebranch.app.link
desktop_uri_scheme
string

Standard URI scheme if available

Example
esp_config
object

Specific configurations for email service providers

map_query_params_to_deep_link_data
Array of string
string
secrets
Array of string
string
strip_protocol_from_deeplink_path
boolean
ExampleFalse
email_enabled
boolean
ExampleFalse
strip_protocol_from_android_deeplink_path
boolean
ExampleFalse
default_to_open_for_android_deeplink_path
boolean
ExampleFalse
append_full_url_for_key
string
Example$canonical_url
append_all_params
boolean
ExampleTrue
ads_enabled
boolean
ExampleFalse
append_path_for_key
string
Example
strip_protocol_from_ios_deeplink_path
boolean
ExampleFalse
has_confirmed
boolean
ExampleTrue
imei_collection_enabled
boolean

Indicate if IMEI collection is enabled

Example
imei_terms_and_conditions
string

IMEI terms and condition if available

Example
ios_bundle_settings
string

iOS settings

Example
ios_additional_bundle_ids
Array of string

Additional ios bundle ids

string
Examplecom.test
ios_cd_enabled
boolean

Indicate if CD [Content Discovery] is enabled for iOS

Example
ios_cd_hashed
string

iOS CD hash details

Example
ipad_url
string

Ipad URL associated with the request

Example
ios_app_store_id
string

Application id specific to iOS

Example
map_utm_params
string
Example
reserved_analytics_to_utm
string
Example
origin
string

Request origin

Example
sitemap_enabled
string

Indicate if CD [Content Discovery] is enabled for Android

Example
tmta_enabled
string
Example
wechat_url
string

Wechat URL against the request

Example
redirect_domains_whitelist
Array of string

Whitelist urls for redirection

string
Example
journeys_open_app
string
Example
passive_deepview_ios
string
Example
passive_deepview_android
string
Example
uri_redirect_mode
integer

URI redirection mode

Example1
timezone
string

Request timezone

ExampleAmerica/Los_Angeles
mac_uri_scheme
string

MAC uri scheme

Examplebranch-example-mac://
mac_store_url
string

Mac Store valid URL if avialable

Example
windows_uri_scheme
string
Exampleexamplebranchsdk://
windows_store_url
string

Windows Store valid URL if avialable

Example
windows_package_family_name
string
Example
organization_id
string
Example
sk_ad_network_enabled
string
Example
ios_app_store_id_verified
boolean

Identifies if the ios app store id is verified officially

Example
local_currency
string

Local currency at the time of request

Example
organic_search_domains
Array of string

Search domains

string
Example
id
string

Request Id

Example00000000
app_key
string

Requesting application key

Example00000000
zuora_account_id
string
Example
branch_key
string

The Branch Key of the originating app obtained in your Account Settings

Examplekey_live_xxxx
branch_secret
string

The Branch Secret of the originating app obtained in your Account Settings

Examplesecret_live_xxxx
creation_date
string

Date app was created

Example2019-06-19T19:37:31.887Z
app_name
string

Name of the app

ExampleMy App Name
dev_name
string

Main contact name

ExampleFirst Last
dev_email
string

Main contact email

dev_phone_number
string

Main contact phone

Example
android_app
integer

Whether an Android app is enabled. 0 is for disabled. 1 is for enabled.

Example0
android_url
string

url of Android store, or namespace (com.android.myapp)

Example
android_uri_scheme
string

the Android URI scheme

Example
android_package_name
string

the Android package name

Example
sha256_cert_fingerprints
Array of string

The SHA256 fingerprints for App Links

string
android_app_links_enabled
boolean

whether App Links are enabled

ExampleFalse
ios_app
integer

whether an iOS app is enabled

Example0
ios_url
string

Url of iOS store, or app id (id00000000)

Example
ios_uri_scheme
string

The iOS URI scheme

Example
ios_store_country
string

The country code of the app, default to US

ExampleUS
ios_bundle_id
string

The iOS bundle ID

Examplecom.test.app
ios_team_id
string

The iOS Team ID

Example0000XXXX
universal_linking_enabled
string

whether Universal Links are enabled

Example
fire_url
string

the redirect on Fire phones

Example
windows_phone_url
string

the redirect on Windows phones

Example
blackberry_url
string

The redirect on Blackberry phones

Example
web_url
string

backup website if URLs are null

Examplehttps://branch.io
default_desktop_url
string

the default desktop redirect, or null if set to hosted SMS

Examplehttp://branch.io
short_url_domain
string

white labeled domain for short links

Example
text_message
string

text message to use, {{ link }} will be replaced with short link

Example
og_app_id
string

optional default Open Graph (OG) app id

Example
og_title
string

optional default OG title

ExampleBranch Monster Factory
og_image_url
string

optional default OG image URL

Example
og_description
string

optional default OG description

Example
deepview_desktop
string

the current deepview selected for the desktop platform

Example
deepview_ios
string

the current deepview selected for the iOS platform

Example
deepview_android
string

the current deepview selected for the Android platform

Example
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