Create Dynamic Link

post

https://api.linkhive.tech/api/dynamicLinks/create

This is your first endpoint! Edit this page to start documenting your API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint creates a dynamic link with optional platform-specific redirection settings.

Query Params

projectId

string

required

Defaults to 3fa85f64-5717-4562-b3fc-2c963f66afa6

platformIds

array of strings

required

platformIds*

Body Params

dynamicLinkPath

string

Optional path that will be appended to the final redirect link. For example, if link is https://yourwebsite.com/page, and dynamicLinkPath is promo/user123, then the final redirect target will be https://yourwebsite.com/page/promo/user123.

linkMetadata

object

Optional metadata map. Contains key-value pairs (both strings) to pass along with the dynamic link, for tracking or client-side usage.

utmSource

string

Identifies the source of the traffic (e.g., google, newsletter, facebook).

utmMedium

string

Identifies the marketing medium (e.g., email, cpc, banner).

utmCampaign

string

Identifies the campaign name or ID (e.g., summer_sale, launch2025).

utmContent

string

Differentiates similar content or links (e.g., header-link, footer-link).

utmTerm

string

Identifies search keywords or terms (used mostly in paid search).

socialMediaTitle

string

The title to display in social media previews (used in Open Graph og:title).

socialMediaDescription

string

The description shown in the preview card (used in Open Graph og:description).

socialMediaImageUrl

string

URL to the image used in the preview (Open Graph og:image). Should be a fully qualified URL.

socialMediaType

string

Type of content, such as article, website, etc. (Open Graph og:type).

skipPreviewPage

boolean

required

Defaults to true

If true, skips the preview/interstitial page and forces the link to open directly in the app (deep link behavior).

generateQrCode

boolean

required

Defaults to false

If true, generates a QR code for the dynamic link and includes it in the response.

Responses

201Created

400Bad Request

401Unauthorized