Branch Android SDK change log

• v6.0.0-beta.3

• Beta Release - Oct 15, 2026

  Upgrade instructions: https://help.branch.io/developer-hub/android-sdk-6-integration

  • Added BranchConfiguration, built with BranchConfiguration.Builder("<branch_key>"). It holds the settings that used to be Branch setters: test mode, API and CDN URLs, EU endpoint, log level and logging callback, request tracing callback, network timeouts, retry count and interval, remote interface, attribution level, DMA parameters, Facebook app ID, preinstall campaign and partner, install metadata, preinstalled app link attribution, allowed schemes, URI hosts to skip, user agent fetch mode and automatic open events.
  • Added Branch.initialize(Context, BranchConfiguration) to initialize the SDK. Removed getAutoInstance; use Branch.getInstance() after initialize.
    • The Branch key is no longer read from AndroidManifest.xml. Pass it to BranchConfiguration.Builder.
  • Added Branch.updateConfiguration(BranchConfiguration) to change settings after initialization. The Branch key, test mode, remote interface, Facebook app ID, preinstall settings, install metadata and automatic open events apply only at initialize.
    • Removed the old setters:
      -- setBranchKey
      -- enableTestMode / disableTestMode
      -- setAPIUrl
      -- setCDNBaseUrl
      -- useEUEndpoint
      -- setNetworkTimeout
      -- setNetworkConnectTimeout
      -- setRetryCount
      -- setRetryInterval
      -- setNoConnectionRetryMax
      -- setCallbackForTracingRequests
      -- setBranchRemoteInterface
      -- setFBAppID
      -- setPreinstallCampaign / setPreinstallPartner
      -- addInstallMetadata
      -- setReferringLinkAttributionForPreinstalledAppsEnabled
      -- addWhiteListedScheme / setWhiteListedSchemes
      -- addUriHostsToSkip
      -- setIsUserAgentSync
      -- setInstallReferrerTimeout
      -- setDeepLinkDebugMode
  • New deep link API requestDeepLinkData replaces sessionBuilder(...).init() and reInit(). Call it in onCreate and onNewIntent:
    • requestDeepLinkData(Activity, BranchReferralInitListener)
    • requestDeepLinkData(Uri, BranchReferralInitListener)
    • Removed sessionBuilder, expectDelayedSessionInitialization, removeSessionInitializationDelay, bypassWaitingForIntent, enableBypassCurrentActivityIntentState, ignoreIntent, isWaitingForIntent, unlockPendingIntent, resetUserSession and the instant deep linking methods.
  • Added manual open control: BranchConfiguration.Builder.setAutomaticOpenEvents (default true).
  • Added Branch.sendOpen(SendOpenListener). If automatic open events are set to false, use it to send the open event yourself.
  • Added Kotlin suspend functions: Branch.requestDeepLinkData, Branch.sendOpen, BranchEvent.awaitLogEvent, BranchUniversalObject.createLink and BranchShortLinkBuilder.createLink.
  • Replaced setIdentity with setUserAlias.
  • Deprecated disableTracking. Use setAttributionLevel with BranchAttributionLevel.NONE in BranchConfiguration, or setConsumerProtectionAttributionLevel.
  • Replaced setDMAParamsForEEA with the DMAParameters class and setDMAParameters.
  • Removed setLimitFacebookTracking and disableAdNetworkCallouts.
  • Removed registerView, BranchUniversalObject.showShareSheet, the BranchUniversalObject content indexing methods, disableDeviceIDFetch, disableAppList and showInstallPrompt.
  • Requests run on Kotlin coroutines instead of AsyncTask.

• v5.21.3
  • Add ProGuard rule to keep AdvertisingIdClient class name for referencing. Removes need for developer to add this rule.

• v5.21.2
  • Updated Google Play Billing library to 8.0.0
  • Fixed logging bug

• v5.21.1
  • Fix for getLastAttributedTouchData(BranchLastAttributedTouchDataListener()) with no attributionWindow parameter, now correctly uses attribution window value configured in app dashboard.

• v5.21.0
  • Add an optional configuration to allow cancelling Install Referrer fetch.
    • setInstallReferrerTimeout(int timeoutInMilliseconds)
    • After the Branch singleton is initialized in Application onCreate
      For example:
      Branch.getInstance().setInstallReferrerTimeout(250)
      Or use branch.json

      {
         "installReferrerFetchTimeout": 250
      }
      

    • Setting to 0 milliseconds will not impose a timeout (default behavior).

• v5.20.3

• Master Release - Sep 24, 2025
  • Add some additional debug logging.

• v5.20.2

• Master Release - Sep 19, 2025
  • Fixed bug where identity may not be set on some opens.

• v5.20.1

• Master Release - Sep 8, 2025
  • Fixed a state where a malformed URL could result in service errors and prevent sdk init.

• v5.20.0

• Master Release - Aug 5, 2025
  • Fix race condition with setIdentity and logout, now happen in order of events enqueued.
  • Expose getInitState() for callers to determine session status.

• v5.19.0

• Master Release - Jun 23, 2025
  • Add method for manually removing intent lock for rare cases where onResume is not called or lock is placed after lifecycle callback.