Try It!
Try out the App API for your Branch App via the API reference here.
Overview
The App API allows developers to view and make updates to an existing Branch app configuration.
Account Requirements
In order to configure your app via the App API, you need to be Self-Serve Customer or an Enterprise Customer.
Prerequisites
In order to access the App API, you need to have completed the following:
- Created a Branch Dashboard
Authentication
Calls to the App API require both your Branch Key and Branch Secret parameter to be passed with each request. This can be obtained through the Branch Dashboard Account Settings.
Learn more about your Branch Account Profile here.
API Usage
Get Current Branch App Config
Endpoint
GET /v1/app/{branch_key}?branch_secret={branch_secret}
Content-Type: application/json
Body: JSON parameters
Host: api2.branch.io
Request Parameters
| Parameter | Description | Required |
|---|---|---|
| branch_key | The Branch key of the originating app; from your Branch Settings Dashboard | Yes |
| branch_secret | The Branch secret if the originating app; from your Branch Settings Dashboard | Yes |
Example Request/Response
curl GET 'https://api2.branch.io/v1/app/{branch_key}?branch_secret={branch_secret}'
{
branch_key: "the app key",
branch_secret: "the app secret",
creation_date : "date app was created",
app_name: "name of the app",
dev_name: "main contact name",
dev_email: "main contact email",
dev_phone_number: "main contact phone",
android_app: "whether an Android app is enabled",
android_url: "url of Android store, or namespace (com.android.myapp)",
android_uri_scheme: "the Android URI scheme",
android_package_name: "the Android package name",
sha256_cert_fingerprints: "the SHA256 fingerprints for App Links",
android_app_links_enabled: "whether App Links are enabled",
ios_app: "whether an iOS app is enabled",
ios_url: "url of iOS store, or app id (id512451233)",
ios_uri_scheme: "the iOS URI scheme",
ios_store_country: "the country code of the app, default to US",
ios_bundle_id: "the iOS bundle ID",
ios_team_id: "the iOS Team ID",
universal_linking_enabled: "whether Universal Links are enabled",
fire_url: "the redirect on Fire phones",
windows_phone_url: "the redirect on Windows phones",
blackberry_url: "The redirect on Blackberry phones",
web_url: "backup website if URLs are null",
default_desktop_url: "the default desktop redirect, or null if set to hosted SMS",
short_url_domain: "white labeled domain for short links",
text_message: "text message to use, {{ link }} will be replaced with short link",
og_app_id: "optional default Open Graph (OG) app id",
og_title: "optional default OG title",
og_image_url: "optional default OG image URL",
og_description: "optional default OG description",
deepview_desktop: "the current deepview selected for the desktop platform",
deepview_ios: "the current deepview selected for the iOS platform",
deepview_android: "the current deepview selected for the Android platform",
}
Update Branch App Config
Endpoint
PUT /v1/app/{branch_key}
Content-Type: application/json
Body: JSON parameters
Host: api2.branch.io
Request Parameters
| Parameter | Description | Required |
|---|---|---|
| branch_secret | The Branch secret if the originating app; from your Branch Settings Dashboard | Yes |
| app_name | The name of the app (max 255 characters). | No |
| dev_name | The main contact developer name (max 255 characters). | No |
| dev_email | The main contact developer email (max 255 characters). | Yes |
| android_url | The url of the Android store, or package name (com.android.myapp). Note that to set a fallback URL for Android instead, you must also set android_app to 2. | No |
| android_uri_scheme | The Android URI scheme. | No |
| ios_url | The url of iOS store, or app id (id512451233) | No |
| ios_uri_scheme | The iOS URI scheme. | No |
| ios_store_country | The country code of the app, default to US (max 255 characters). | No |
| web_url | Backup website if URLs are null. | No |
| text_message | The text message to use for text-me feature, {{ link }} will be replaced with short link (max 255 characters). | No |
| og_app_id | Default Open Graph (OG) app id (max 255 characters). | No |
| og_title | Default OG title to be used with links (max 255 characters). | No |
| og_description | Default OG description to be used with links (max 255 characters). | No |
| og_image_url | Default OG image URL to be used with links (max 255 characters). | No |
Example Request/Response
curl --request PUT \
--url 'https://api2.branch.io/v1/app/key_live_XXXX' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{
"branch_secret": "secret_live_XXXX",
"dev_email": "[email protected]",
"og_title": "New App Title"
}
'
{
branch_key: "the app key",
branch_secret: "the app secret",
creation_date : "date app was created",
app_name: "name of the app",
dev_name: "main contact name",
dev_email: "main contact email",
dev_phone_number: "main contact phone",
android_url: "url of Android store, or namespace (com.android.myapp)",
android_uri_scheme: "the Android URI scheme",
ios_url: "url of iOS store, or app id (id512451233)",
ios_uri_scheme: "the iOS URI scheme",
ios_store_country: "the country code of the app, default to US",
web_url: "backup website if URLs are null",
short_url_domain: "white labeled domain for short links",
text_message: "text message to use, {{ link }} will be replaced with short link",
og_app_id: "optional default Open Graph (OG) app id",
og_title: "optional default OG title",
og_image_url: "optional default OG image URL",
og_description: "optional default OG description"
}