At a glance: Create, update, retrieve, and delete OneLink short URLs via the OneLink REST API.
Overview
OneLink API is used to:
- Create, get, update, and delete OneLink short URLs automatically.
- Generate a large number of OneLink custom attribution links.
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 (if logged in), and a special offer for bananas that are on sale.
Who is involved:
Marketer and developer
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 |
The rate limit of creating OneLink attribution links via API is 250K per day, per account. |
Custom links |
|
TTL |
|