At a glance: OneLink API helps you engage end-users and leverage owned media by generating personalized links in large-scale campaigns, via SMS, and more. Requires both advertiser and developer to implement.
OneLink API
OneLink API is used to:
- Create, get, update, and delete OneLink short URLs with customized parameters automatically.
Parameters can be either:- Attribution-related parameters, used for measuring and monitoring marketing efforts, like media source, campaign, adset, etc.
- Personalization parameters, that let you configure a customized user experience when opening the app from the relevant link. These params let you send users to customized in-app content, for example, a specific product page, coupon code, promotion, etc.
- Allow the sharing of website/app content directly to mobile users (thereby increasing mobile engagement and installs).
- Generate a large number of OneLink custom attribution links instantly.
Note: For referral links, see the User invite attribution article. - Customize OneLink URLs with your brand. This means that when you generate the URL, it has your brand domain, instead of the OneLink subdomain.
Example
Feed Me, a grocery delivery service, wants to send a personalized link via SMS to existing customers to encourage them to download the Feed Me app and buy bananas. Based on the country of the customer, Feed Me uses the OneLink REST API to build a custom OneLink URL that contains specific details for the country, user identity, and a special offer for bananas that are on sale.
Procedures
To set up OneLink API:
- Create a OneLink template.
- Record the OneLink ID.
- Record the OneLink API key. The account admin needs to retrieve the API key. Team members do not have access to the API Key.
- Give the OneLink ID and the OneLink API key to the developer.
- Tell the developer to follow the instructions in the dev hub.
Limitations
Limitation |
Remarks |
---|---|
API rate |
|
Custom links visibility |
|
TTL |
|