App API

The App API lets you view and update an existing Branch app configuration to better support workflows.

Read the App API overview

Get current Branch app configuration

GET/app/{branch_key}

This endpoint retrieves all app-related configurations for the requested branch.

Parameters

branch_keystringpathRequired
The Branch Key of the originating app obtained in your Account Settings.
branch_secretstringqueryRequired
The Branch Secret of the originating app obtained in your Account Settings.

Returns

Success. Returns 400 and 429 on failure — see the response panel for the error shape.

branch_key*branch_secret*

curl 'https://api2.branch.io/v1/app/key_live_xxxx?branch_secret=secret_live_xxxx' \
  --request GET

Response

Success.

{
  "alternate_short_url_domain": "branch-alternate.app.link",
  "always_open_app": 1,
  "android_cd_enabled": false,
  "android_cd_hashed": "",
  "android_tablet_url": "",
  "auto_fetch": false,
  "deepview_configs": {
    "ios": {
      "enabled": true,
      "clipboard_deepview": "branch_clipboard_deepview",
      "deepview_audience_id": 0
    },
    "android": {
      "enabled": true,
      "clipboard_deepview": "branch_clipboard_deepview",
      "deepview_audience_id": 0
    }
  },
  "default_short_url_domain": "branch.app.link",
  "desktop_uri_scheme": "",
  "esp_config": {
    "map_query_params_to_deep_link_data": [
      ""
    ],
    "secrets": [
      ""
    ],
    "strip_protocol_from_deeplink_path": false,
    "email_enabled": false,
    "strip_protocol_from_android_deeplink_path": false,
    "default_to_open_for_android_deeplink_path": false,
    "append_full_url_for_key": "$canonical_url",
    "append_all_params": true,
    "ads_enabled": false,
    "append_path_for_key": "",
    "strip_protocol_from_ios_deeplink_path": false,
    "has_confirmed": true
  },
  "imei_collection_enabled": false,
  "imei_terms_and_conditions": "",
  "ios_bundle_settings": "",
  "ios_additional_bundle_ids": [
    "com.test"
  ],
  "ios_cd_enabled": false,
  "ios_cd_hashed": "",
  "ipad_url": "",
  "ios_app_store_id": "",
  "map_utm_params": "",
  "reserved_analytics_to_utm": "",
  "origin": "",
  "sitemap_enabled": "",
  "tmta_enabled": "",
  "wechat_url": "",
  "redirect_domains_whitelist": [
    ""
  ],
  "journeys_open_app": "",
  "passive_deepview_ios": "",
  "passive_deepview_android": "",
  "uri_redirect_mode": 1,
  "timezone": "America/Los_Angeles",
  "mac_uri_scheme": "branch-example-mac://",
  "mac_store_url": "",
  "windows_uri_scheme": "examplebranchsdk://",
  "windows_store_url": "",
  "windows_package_family_name": "",
  "organization_id": "",
  "sk_ad_network_enabled": "",
  "ios_app_store_id_verified": false,
  "local_currency": "",
  "organic_search_domains": [
    ""
  ],
  "id": "00000000",
  "app_key": "00000000",
  "zuora_account_id": "",
  "branch_key": "key_live_xxxx",
  "branch_secret": "secret_live_xxxx",
  "creation_date": "2019-06-19T19:37:31.887Z",
  "app_name": "My App Name",
  "dev_name": "First Last",
  "dev_email": "test@branch.io",
  "dev_phone_number": "",
  "android_app": 0,
  "android_url": "",
  "android_uri_scheme": "",
  "android_package_name": "",
  "sha256_cert_fingerprints": [
    ""
  ],
  "android_app_links_enabled": false,
  "ios_app": 0,
  "ios_url": "",
  "ios_uri_scheme": "",
  "ios_store_country": "US",
  "ios_bundle_id": "com.test.app",
  "ios_team_id": "0000XXXX",
  "universal_linking_enabled": "",
  "fire_url": "",
  "windows_phone_url": "",
  "blackberry_url": "",
  "web_url": "https://branch.io",
  "default_desktop_url": "http://branch.io",
  "short_url_domain": "",
  "text_message": "",
  "og_app_id": "",
  "og_title": "Branch Monster Factory",
  "og_image_url": "",
  "og_description": "",
  "deepview_desktop": "",
  "deepview_ios": "",
  "deepview_android": ""
}

Update Branch app configuration

PUT/app/{branch_key}

Updates an existing Branch app configuration. Any parameters included in the request body are updated to the provided values.

Parameters

branch_keystringpathRequired
The Branch Key of the originating app obtained in your Account Settings.
branch_secretstringRequired
The Branch Secret of the originating app obtained in your Account Settings.
dev_emailstringRequired
The main contact developer email (max 255 characters).
always_open_appenum
Indicates whether to try to open the app on link click or not.
01
android_appenum
Whether an Android app is enabled. 0 is for disabled. 1 is for enabled.
01
android_app_links_enabledenum
Whether App Links are enabled.
truefalse
android_cd_enabledboolean
Indicates whether Content Discovery (CD) is enabled for Android.
android_cd_hashedstring
Android CD hash details.

More parameters

android_package_namestring
android_tablet_urlstring
android_uri_schemestring
android_urlstring
app_namestring
auto_fetchboolean
blackberry_urlstring
creation_datestring
deepview_androidstring
deepview_configsobject
deepview_desktopstring
deepview_iosstring
default_desktop_urlstring
default_short_url_domainstring
desktop_uri_schemestring
dev_namestring
dev_phone_numberstring
esp_configobject
fire_urlstring
imei_collection_enabledboolean
imei_terms_and_conditionsstring
ios_additional_bundle_idsarray of string
ios_appinteger
ios_app_store_idstring
ios_app_store_id_verifiedboolean
ios_bundle_idstring
ios_bundle_settingsstring
ios_cd_enabledboolean
ios_cd_hashedstring
ios_store_countrystring
ios_team_idstring
ios_uri_schemestring
ios_urlstring
ipad_urlstring
journeys_open_appstring
mac_store_urlstring
mac_uri_schemestring
map_utm_paramsstring
og_app_idstring
og_descriptionstring
og_image_urlstring
og_titlestring
organic_search_domainsarray of string
originstring
passive_deepview_androidstring
passive_deepview_iosstring
redirect_domains_whitelistarray of string
reserved_analytics_to_utmstring
sha256_cert_fingerprintsarray of string
sitemap_enabledstring
text_messagestring
timezonestring
universal_linking_enabledstring
uri_redirect_modeinteger
web_urlstring
wechat_urlstring
windows_package_family_namestring
windows_phone_urlstring
windows_store_urlstring
windows_uri_schemestring

Returns

Success. Returns 400 and 429 on failure — see the response panel for the error shape.

branch_key*

{
  "branch_secret": "secret_live_xxxx",
  "dev_email": "test@branch.io",
  "deepview_configs": {
    "ios": {
      "enabled": true,
      "clipboard_deepview": "branch_clipboard_deepview"
    },
    "android": {
      "enabled": true,
      "clipboard_deepview": "branch_clipboard_deepview"
    }
  },
  "default_short_url_domain": "branch.app.link",
  "esp_config": {
    "append_full_url_for_key": "https://example.com/sample-page/",
    "append_all_params": true,
    "has_confirmed": true
  },
  "ios_additional_bundle_ids": [
    "com.test"
  ],
  "uri_redirect_mode": 1,
  "timezone": "America/Los_Angeles",
  "mac_uri_scheme": "branch-example-mac",
  "windows_uri_scheme": "examplebranchsdk",
  "creation_date": "2019-06-19T19:37:31.887Z",
  "app_name": "My App Name",
  "dev_name": "First Last",
  "ios_store_country": "US",
  "ios_bundle_id": "com.test.app",
  "ios_team_id": "0000XXXX",
  "web_url": "https://branch.io",
  "default_desktop_url": "http://branch.io",
  "og_title": "Branch Monster Factory"
}

curl 'https://api2.branch.io/v1/app/key_live_xxxx' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
    "branch_secret": "secret_live_xxxx",
    "dev_email": "test@branch.io",
    "deepview_configs": {
      "ios": {
        "enabled": true,
        "clipboard_deepview": "branch_clipboard_deepview"
      },
      "android": {
        "enabled": true,
        "clipboard_deepview": "branch_clipboard_deepview"
      }
    },
    "default_short_url_domain": "branch.app.link",
    "esp_config": {
      "append_full_url_for_key": "https://example.com/sample-page/",
      "append_all_params": true,
      "has_confirmed": true
    },
    "ios_additional_bundle_ids": [
      "com.test"
    ],
    "uri_redirect_mode": 1,
    "timezone": "America/Los_Angeles",
    "mac_uri_scheme": "branch-example-mac",
    "windows_uri_scheme": "examplebranchsdk",
    "creation_date": "2019-06-19T19:37:31.887Z",
    "app_name": "My App Name",
    "dev_name": "First Last",
    "ios_store_country": "US",
    "ios_bundle_id": "com.test.app",
    "ios_team_id": "0000XXXX",
    "web_url": "https://branch.io",
    "default_desktop_url": "http://branch.io",
    "og_title": "Branch Monster Factory"
  }'

Response

Success.

{
  "alternate_short_url_domain": "branch-alternate.app.link",
  "always_open_app": 1,
  "android_cd_enabled": false,
  "android_cd_hashed": "",
  "android_tablet_url": "",
  "auto_fetch": false,
  "deepview_configs": {
    "ios": {
      "enabled": true,
      "clipboard_deepview": "branch_clipboard_deepview",
      "deepview_audience_id": 0
    },
    "android": {
      "enabled": true,
      "clipboard_deepview": "branch_clipboard_deepview",
      "deepview_audience_id": 0
    }
  },
  "default_short_url_domain": "branch.app.link",
  "desktop_uri_scheme": "",
  "esp_config": {
    "map_query_params_to_deep_link_data": [
      ""
    ],
    "secrets": [
      ""
    ],
    "strip_protocol_from_deeplink_path": false,
    "email_enabled": false,
    "strip_protocol_from_android_deeplink_path": false,
    "default_to_open_for_android_deeplink_path": false,
    "append_full_url_for_key": "$canonical_url",
    "append_all_params": true,
    "ads_enabled": false,
    "append_path_for_key": "",
    "strip_protocol_from_ios_deeplink_path": false,
    "has_confirmed": true
  },
  "imei_collection_enabled": false,
  "imei_terms_and_conditions": "",
  "ios_bundle_settings": "",
  "ios_additional_bundle_ids": [
    "com.test"
  ],
  "ios_cd_enabled": false,
  "ios_cd_hashed": "",
  "ipad_url": "",
  "ios_app_store_id": "",
  "map_utm_params": "",
  "reserved_analytics_to_utm": "",
  "origin": "",
  "sitemap_enabled": "",
  "tmta_enabled": "",
  "wechat_url": "",
  "redirect_domains_whitelist": [
    ""
  ],
  "journeys_open_app": "",
  "passive_deepview_ios": "",
  "passive_deepview_android": "",
  "uri_redirect_mode": 1,
  "timezone": "America/Los_Angeles",
  "mac_uri_scheme": "branch-example-mac://",
  "mac_store_url": "",
  "windows_uri_scheme": "examplebranchsdk://",
  "windows_store_url": "",
  "windows_package_family_name": "",
  "organization_id": "",
  "sk_ad_network_enabled": "",
  "ios_app_store_id_verified": false,
  "local_currency": "",
  "organic_search_domains": [
    ""
  ],
  "id": "00000000",
  "app_key": "00000000",
  "zuora_account_id": "",
  "branch_key": "key_live_xxxx",
  "branch_secret": "secret_live_xxxx",
  "creation_date": "2019-06-19T19:37:31.887Z",
  "app_name": "My App Name",
  "dev_name": "First Last",
  "dev_email": "test@branch.io",
  "dev_phone_number": "",
  "android_app": 0,
  "android_url": "",
  "android_uri_scheme": "",
  "android_package_name": "",
  "sha256_cert_fingerprints": [
    ""
  ],
  "android_app_links_enabled": false,
  "ios_app": 0,
  "ios_url": "",
  "ios_uri_scheme": "",
  "ios_store_country": "US",
  "ios_bundle_id": "com.test.app",
  "ios_team_id": "0000XXXX",
  "universal_linking_enabled": "",
  "fire_url": "",
  "windows_phone_url": "",
  "blackberry_url": "",
  "web_url": "https://branch.io",
  "default_desktop_url": "http://branch.io",
  "short_url_domain": "",
  "text_message": "",
  "og_app_id": "",
  "og_title": "Branch Monster Factory",
  "og_image_url": "",
  "og_description": "",
  "deepview_desktop": "",
  "deepview_ios": "",
  "deepview_android": ""
}

App API

Get current Branch app configuration

Parameters

Returns

Update Branch app configuration

Parameters

More parameters Expand all

Returns

More parameters