Create OneLink link

post

https://onelink.appsflyer.com/api/v2.0/shortlinks/{onelink-id}

Premium

📘
Note
This API replaces Create OneLink link v1.0

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

onelink-id

string

required

Get this from the person using the AppsFlyer dashboard. Taken from the OneLink template screen

Body Params

shortlink_id

string

The ID of the shortlink created.
If not passed, the ID is a random string.

⚠️
If fired twice, the second call would receive a response of:
409 - Shortlink ID already exists

ttl

string

Time to Live for the full link. Default is 31 days. Maximum is 730 days for API v2. Value can be specified in days (default), minutes or hours (for example, 10m, 20h, 14d). Invalid or out-of-range values are silently clamped to the 31-day default.

brand_domain

string

Only use this param and request it in the payload if: 1) The Branded Links feature is enabled in your account, and 2) The branded link is configured in your account. If these conditions are not met, do not use this param, as the API call will not work.

data

json

required

JSON format of the query parameters following the AppsFlyer macros for links. Note: The media source (pid) parameter is mandatory.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The link was created successfully

400Bad request

401Unauthorized

403Forbidden

404Shortlink not found

409Shortlink ID already exists

429Limit exceeded