Create a DeepLinkNow link
create_linkCreates an app link with a custom path, link-page text, social preview, metadata, and campaign assignment for tailored previews and link grouping.
Instructions
Creates a link in the app that DEEPLINKNOW_API_KEY (a private key) belongs to, with an optional custom path, link-page title and button texts, social preview, metadata and campaign. Creating links is optional: any path on the link domain already works. Use this for a custom preview or to group links in a campaign. Counts toward the plan's link limit. Needs a paid plan with management API access.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | Link page title. | |
| metadata | No | String key/value pairs returned to the app with the link. | |
| subtitle | No | Link page subtitle. | |
| target_url | Yes | Required by the API: an absolute URL stored as the link's target_url and returned to the app as targetUrl (for example the web page for the same content). Apps should route on the link's path and query, not on targetUrl. | |
| campaign_id | No | Add the link to this campaign (must be in the key's app). | |
| custom_path | No | The path on the link domain, e.g. "summer-sale" or "products/123?ref=email" (leading / optional, query sorted). It must pass the app's link path rule. Omit it for a random 8-character path. | |
| social_image | No | Social preview image URL. | |
| social_title | No | Social preview title. | |
| ios_button_text | No | Text of the App Store button on the link page. | |
| social_description | No | Social preview description. | |
| android_button_text | No | Text of the Play Store button on the link page. |