Advanced Settings & Change Your Link Domain

Change Advanced Settings

On the Link Settings on the Branch Dashboard, you can change your advanced link settings:

  1. Set Match type to either unique or normal (default)
    a. Recommended: Normal. Selecting Unique means that Branch will only make a deep link through install match if there is a single, unique outstanding footprint. For example, if you and your twin each have an iPhone 5s with the same OS/version, etc., and you each click different links for the same app then open the app up at the same time, we won’t deep link when Unique is selected. You probably don’t want this, as it’s mostly for very special circumstances.
  2. Set Duration to seconds
    a. Duration is how long a click will live in our system before it is consumed by either an app open or a system delete. Modifying this value will change how long we wait to fingerprint a user. If a user is fingerprinted within the set duration, then deep link data will flow into the app. The default expiration is 2 hours (7200 seconds).
  3. Set UTM tags
    a. Recommend disabled. If you enable this, Branch will automatically set channel, feature, campaign, tags and $keywords based on UTM params. This only applies to dynamically created links, not links generated through the Dashboard, API or SDKs.
UTM parameterBranch parameter
utm_sourceChannel
utm_mediumFeature
utm_campaignCampaign
utm_contentTags
utm_termKeywords (not visible on Dashboard)

Change Your Link Domain

The app.link domain is the default Branch domain. Upon dashboard signup, you will automatically be assigned an app.link domain that has a multi-character scramble as a sub-domain (Example: xxxxxx.app.link). You can change your link domain to a custom app.link domain, custom subdomain, or custom root domain.

Customize Your app.link Domain

The majority of Branch customers choose to customize their app.link domain, as this allows you to match your Branch subdomain to your brand (Example: yourbrand.app.link).

To customize your app.link domain:

  1. Review and understand our domain change warning
  2. Navigate to the Link Settings page on the Branch Dashboard.
  3. Change your subdomain. If you have any issues updating/changing your subdomain, click here to contact support.

🚧

Customize your app.link domain before completing the SDK integration

It is important to update your app.link subdomain before you begin your Branch app SDK integration, otherwise, you will need to make updates to your app’s associated domains and you may see strange link behavior.

❗️

Android App Links & Web-Only Limitations

Currently, we cannot support web-only link functionality ($web_only; links that only open the web even if the app is installed) and Android App Links together on custom root domains and subdomains. Android App Links force the app to open even if $web_only=true is specified on custom root domains and subdomains.

Use a Custom Subdomain

If your enterprise is highly restrictive of the domains that you utilize and wants to ensure that your Branch domain matches the rest of your relevant subdomains, you can utilize a custom subdomain (Example: link.yourbrand.com).

Note: This will require you to CNAME your domain to custom.bnc.lt as well as make relevant in-app associated domain changes if your Branch app SDKs are already integrated.

To Use a Custom Subdomain:

  1. Review and understand Domain change warning
  2. Review and understand Custom domain warning
  3. Review and understand Custom domain debugging
  4. Navigate to Link Settings on the Branch Dashboard, and change your link domain to your custom subdomain.
  5. Update your CNAME record on your custom subdomain
    1. CNAME = custom.bnc.lt
  6. In order to support web-only links on a custom subdomain, create a '-web' subdomain and also point the DNS CNAME to custom.bnc.lt.
    1. Ex. Custom Subdomain: my.brand.com. Web-only domain: my-web.brand.com
  7. Click Confirm on Link settings
  8. If you are configuring the domain through AWS's Route 53, make sure you are editing the nameservers under the Registered Domains tab, and not the Hosted zones section.

Use a Custom Root Domain

Some (extreme minority) companies will establish an entirely separate domain for their Branch domain, creating a custom root (Example: yourbrand-link.com). This is only recommended if your company is not open to the app.link or a custom subdomain option.

Note: This will require you to update your NS records for the domain.

To Use a Custom Root Domain:

  1. Review and understand Domain change warning
  2. Review and understand Custom domain warning
  3. Review and understand Custom domain debugging
  4. Change your link domain to your custom root domain on Link settings
  5. Update your NS records on your custom root domain
    1. These values are unique per app and can only be found in your Branch dashboard when changing your link settings.
  6. In order to support web-only links on a custom root domain, create a 'web' subdomain. Ex. web.brand.com
    1. Ex. Custom Root Domain: brand.com. Web-only domain: web.brand.com
  7. Click Confirm on Link settings
  8. If you are configuring the domain through AWS's Route 53, make sure you are editing the nameservers under the Registered Domains tab, and not the Hosted zones section.

Troubleshooting Issues

Domain change warning

  • Used for Change link domain
  • From app.link to app.link
    • Your old app.link deep links will fail
    • Your old app.link deep links will navigate to a File Not Found website and not open your app.
    • Your new app.link deep links will open your app after your update your code to append the new link domain
    • If your old app.link are active, it is recommend to switch to a custom link domain instead
  • From app.link to custom link domain
    • Your old app.link deep links will still work
    • Your new custom link domain deep links will open your app after your update your code to append the new link domain
  • From custom link domain to custom link domain
    • Your old custom link domain deep links will fail
    • Your new custom link domain deep links will open your app after your update your code to append the new link domain
  • From legacy bnc.lt to custom link domain or app.link
    • Both your bnc.lt and custom link domain / app.link deep links will work
    • Your new custom link domain / app.link deep links will open your app after your update your code to append the new link domain

📘

Change your app configuration with your custom domain

Add an Intent Filter on Android
Add a new key in your apps Info.plist on iOS

Custom domain warning

  • Used for Change link domain
  • The NS or CNAME records of your custom link domain will need to point to Branch if you want to use your own domain for your deep links
  • Whenever you change your NS or CNAME records of a domain, you are making Branch the authoritative registrar for your domain. This will grant Branch control of your domain and you will lose all access to that custom root domain or custom subdomain. The web page will become blank, and the control of the domain will change to Branch
  • Branch will use your domain to route all deep linked traffic. Branch will also host your AASA file and SSL certificates
  • If you have content on your custom root domain (e.g. https://example.com/), Branch recommends using an unused custom subdomain instead (e.g. https://link.example.com/)

Custom domain debugging

  • Used for Change link domain
  • You can test your domain record changes with dig ns <domain> or dig cname <domain>
  • We recommend that you choose one domain or subdomain to use with Branch and stick with it, as switching can cause significant problems with your existing links
  • If you are configuring the domain through AWS's Route 53, make sure you are editing the nameservers under the Registered Domains tab, and not the Hosted zones section
  • You cannot use your main website domain for hosting Branch links
  • Do not include www when adding your custom link domain
  • If you have CAA records set for your domain, add letsencrypt.org to the list

Updated 3 days ago


Advanced Settings & Change Your Link Domain


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.