Create or update a link

post

https://dynalinks.app/api/v1/links/upsert

Creates a new link or updates an existing one if a link with the same path already exists.

Rate Limit: 600 requests per minute.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Link object to be created or updated

name

string

Name of the dynamic link, displayed in the console user interface.

path

string

You can retrieve parameters from the path in your iOS or Android apps and redirect your users to a specific screen.

social_description

string

The content for the meta description tag is the concise summary that appears when the page is shared on social media.

social_image_url

string

A URL to a unique image representing the content of the page.

social_title

string

The content for the meta title tag is the title that appears when the page is shared on social media.

url

string

This address will open when the user clicks on the link on a desktop.

android_fallback_url

string

This address will open when the user clicks on the link on an Android device and the app is not installed.

ios_fallback_url

string

This address will open when the user clicks on the link on an iOS device and the app is not installed.

enable_forced_redirect

boolean

When set to true, bypass the app preview page for Dynalinks, redirecting users directly to the app or store. By default, the app preview page is enabled to ensure users are directed to the most suitable destination when opening links within apps.

referrer

string

(Android only) Parameter for deferred deep linking which can be read using InstallReferrerClient library. This way, you can track the source of the install and attribute the install to the right source. Available on PRO plan only. Important - If your project has "Link in Referrer" feature enabled, this field will be ignored and the referrer parameter will be used exclusively for deferred deep linking (_url parameter). To track custom parameters when this feature is enabled, add them as query parameters to your link URL instead.

ios_deferred_deep_linking_enabled

boolean

(iOS only) Parameter for deferred deep linking which can be read after installation. This way, you can track the source of the install and attribute the install to the right source. Available on PRO plan only.

provider_token

string

(iOS only) Apple's provider token (pt parameter) for App Store campaign tracking. Used for affiliate programs and marketing campaigns. Available on PRO plan only. Must be provided together with campaign_token.

campaign_token

string

(iOS only) Apple's campaign token (ct parameter) for App Store campaign tracking. Used to identify specific marketing campaigns. Available on PRO plan only. Must be provided together with provider_token.

android_app

ios_app

options

object

Additional metadata for the link configuration.

Responses

200Link updated successfully

201Link created successfully

400Bad Request

401Unauthorized

422Unprocessable Entity

429Too Many Requests