Quick Links API
Branch's Quick Links API is a useful tool for programmatically generating Branch Links that surface in Branch. You can create deep links at scale to support all of your campaigns while tagging the links appropriately based on channel and other analytics tags. The API also supports QR code customization during link creation, which lets you programmatically apply branding and design settings to the QR codes associated with your Short Links.
Create Quick Link
POST/url
Creates a Branch Quick Link—a managed deep link that surfaces in Branch. When you include qr_code_settings in the request, both the link and its customized QR code are generated instantly and become visible in Branch. Set type=2 to surface the link in Branch. Customizing a QR code through this endpoint requires access to both the Quick Links API and the QR Code API.
Parameters
- branch_keystringRequired
The Branch Key of the originating app, found on the Settings tab in Branch.
- aliasstring
Instead of our standard encoded short URL, you can specify the vanity alias. For example, instead of a random string of characters/integers, you can set the vanity alias as .app.link/spring-launch.
- analyticsobject
- campaignstring
Campaign name.
- channelstring
Deep link channel.
- dataobject
- durationinteger
In seconds. Only set this key if you want to override the match duration for deep link matching. This is the time that Branch allows a click to remain outstanding and be eligible to be matched with a new app session. The default is 7200 (2 hours).
- featurestring
Deep link feature set.
More parameters
Returns
Success. Returns 400 and 429 on failure — see the response panel for the error shape.
Create Quick Links in bulk
POST/url/bulk/{branch_key}
Creates multiple Quick Links in a single request. Each entry in the request array follows the same shape as a single Create Quick Link payload.
Parameters
- branch_keystringpathRequired
The Branch Key of the originating app, found on the Settings tab in Branch.
- aliasstring
Instead of our standard encoded short URL, you can specify the vanity alias. For example, instead of a random string of characters/integers, you can set the vanity alias as .app.link/spring-launch.
- analyticsobject
- campaignstring
Campaign name.
- channelstring
Deep link channel.
- dataobject
- durationinteger
In seconds. Only set this key if you want to override the match duration for deep link matching. This is the time that Branch allows a click to remain outstanding and be eligible to be matched with a new app session. The default is 7200 (2 hours).
- featurestring
Deep link feature set.
More parameters
Returns
Success. Returns 400 and 429 on failure — see the response panel for the error shape.
Update Quick Link
PUT/url
Updates an existing Branch Quick Link. You can also update the QR code design on an existing link by including qr_code_settings in the request body.
Parameters
- branch_keystringRequired
The Branch Key of the originating app, found on the Settings tab in Branch.
- branch_secretstringRequired
The Branch Secret of the originating app, found on the Settings tab in Branch.
- urlstringqueryRequired
The full URL of the Quick Link to update.
- analyticsobject
- campaignstring
Campaign name.
- channelstring
Deep link channel.
- dataobject
- durationinteger
In seconds. Only set this key if you want to override the match duration for deep link matching. This is the time that Branch allows a click to remain outstanding and be eligible to be matched with a new app session. The default is 7200 (2 hours).
More parameters
Returns
Quick Link updated successfully. Returns 400 and 429 on failure — see the response panel for the error shape.