adjust-icon

Deep link generator API

Use the Deep link generator API to create short and long deep links for your apps, individually or in bulk. These customized deep links enhance the user experience across various platforms.

Before you begin

Here’s what you need to know before getting started.

Availability

  • You need to be on the TrueLink Core, or Enterprise package to get access to the Deep link generator API.
  • Links created using the Deep link generator API aren’t displayed in Campaign Lab.
  • The TTL (time-to-live) for shorts links created using the Deep link generator API is 120 days.

Requirements

Authentication

The Deep link generator API uses Bearer tokens for authentication. You MUST include your Adjust API token in an Authorization header with each request you make to the Deep link generator API.

If your organization has enabled Single Sign-On (SSO), contact your Adjust representative or email support@adjust.com for help with finding your API token.

For non-SSO accounts, API tokens are located in a user’s profile. To find your token, follow these steps:

  1. Select the account (user) icon.
  2. Select Account settings.
  3. Select the My profile tab.
  4. Your API Token is shown with your User Details. Select the copy button to copy the token to your system clipboard.

Reset your Adjust API token

You can reset your Adjust API token at any time. Resetting your token invalidates the old token. If you reset your Adjust API token, you MUST replace your old token anywhere that you’re using it. Requests made with an invalidated token are rejected by Adjust.

To reset your Adjust API token:

  1. Select the account (user) icon.
  2. Select Account settings.
  3. Select the My Profile tab.
  4. Your API Token is shown with your User details.
  5. Select Reset API token.
  6. Enter your account password in the modal that appears and select Reset to reset your API token. A confirmation appears in the top right of the screen.
  7. Select the copy button next to the API Token to copy the token to your system clipboard.

Parameters

ParameterData typeInDescription
adjust_auth_tokenStringHeaderAdjust API token
link_tokenStringBodyThe link token from your custom link. If you’re generating deep links from a combined link, ensure that you use the correct link token from the combined custom link in Campaign Lab.
shorten_urlBooleanBodyWhether the link will be shortened. The link isn’t shortened by default. Default value - false
campaignString or nullBodyThe name of the campaign
adgroupString or nullBodyThe name of the adgroup
creativeString or nullBodyThe name of the creative
deep_link_pathStringBodySpecifies the in-app destination your users are taken to. Use this for single-platform apps.
ios_deep_link_pathStringBodySpecifies the iOS in-app destination your users are taken to. Use this for multi-platform iOS apps or combined links.
android_deep_link_pathStringBodySpecifies the Android in-app destination your users are taken to. Use this for multi-platform Android apps or combined links.
fallbackStringBodyLanding page where you send off-platform users. When you specify the fallback URL, it’s recommended to specify redirect_macos for macOS users.
redirect_macosStringBodyRedirect URL to override Adjust’s default redirect for macOS. When you specify the fallback, it’s recommended to specify this parameter for macOS users.
labelStringBodyAdds custom data to the link. Use this parameter to add a unique user referral ID that’s autopopulated when a user shares a short link from your app.
og_titleStringBodyTitle of the social sharing preview of the link.
og_descriptionStringBodyDescription of the social sharing preview of the link.
og_imageStringBodyURL to a JPG or PNG image of at least 200 x 200 pixels size for the social sharing preview of the link.

Send a POST request to generate a long or a short deep link for single- or multi-platform apps.

Endpoint

https://automate.adjust.com/engage/deep-links

Examples

Single-platform apps

Request - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"link_token": "1c52mluz",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"deep_link_path": "/custom-path",
"shorten_url": true
}'
Response
{"url": "https://insights.go.link/fryYl"}

Multi-platform apps

Request - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"link_token": "2d41nkvy",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"android_deep_link_path": "/custom-path",
"redirect_macos": "https://www.example.com/redirectmacos",
"shorten_url": true
}'
Response
{"url": "https://insights.go.link/jlbKj"}

Combined links

Ensure that you create a combined custom link in Campaign Lab before you generate a deep link using the Deep link generator API.

Request - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"link_token": "1c2n7ybx_1cjet4nl",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"ios_deep_link_path": "/custom-path-ios",
"android_deep_link_path": "/custom-path-android",
"redirect_macos": "https://www.example.com/redirectmacos",
"shorten_url": true
}'
Response
{"url": "https://insights.go.link/6JtQx"}

Send a POST request to generate long or short deep links for single- or multi-platform apps in bulk.

Endpoint

https://automate.adjust.com/engage/deep-links/bulk

Example

Request - cURL
curl --location 'https://automate.adjust.com/engage/deep-links/bulk' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"data": [
{
"link_token": "1doptv0c",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"campaign": "custom-campaign",
"shorten_url": true
},
{
"link_token": "1df3xslh_1dsykkaa",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"ios_deep_link_path": "/custom-path-ios",
"android_deep_link_path": "/custom-path-android",
"shorten_url": true
},
{
"link_token": "1dzwtdjt",
"redirect": "https://example.com/redirect",
"fallback": "https://example.com/fallback",
"android_deep_link_path": "/custom-path",
"shorten_url": true
}
]
}'
Response
{
"data": [
{
"url": "https://kapp.go.link/4IlkC"
},
{
"url": "https://kapp.go.link/6KnoE"
},
{
"url": "https://insights.go.link/5JmnD"
}
]
}

Send a PUT request to update an existing short link token in a deep link to a long link.

Endpoint

https://automate.adjust.com/engage/deep-links/{short_token}

Example

Request - cURL
curl --location --request PUT 'https://automate.adjust.com/engage/deep-links/4IlkC' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"link_token": "1doptv0c",
"redirect": "https://example.com/new-redirect",
"fallback": "https://example.com/new-fallback",
"deep_link_path": "/new-custom-path"
}'
Response
204 No Content