Generate a Link

Create links programmatically using the Grovs REST API

POSThttps://sdk.sqd.link/api/v1/sdk/generate_link

Create a new link with custom metadata, platform-specific redirects, and tracking parameters.

Headers

PROJECT-KEYstringrequired

Your SDK project key. Found in Dashboard → Developer → API Key.

ENVIRONMENTstringrequired

Target environment. Use production or development.

Content-Typestringrequired

Must be application/json.

Body Parameters

Core

titlestringoptional

Title displayed in the link preview.

subtitlestringoptional

Subtitle text for additional context in previews.

datastringoptional

Stringified JSON containing metadata delivered to the app via SDK. Example: "{\"screen\": \"promo\"}".

tagsstringoptional

Stringified JSON array for categorization. Example: "[\"campaign\", \"summer\"]".

Platform Redirects

ios_custom_redirectobjectoptional

iOS-specific redirect. Contains url (string) and open_app_if_installed (boolean).

android_custom_redirectobjectoptional

Android-specific redirect. Contains url (string) and open_app_if_installed (boolean).

desktop_custom_redirectobjectoptional

Desktop browser fallback. Contains url (string).

Link Preview

show_preview_iosbooleanoptional

Show a preview page on iOS. Improves UX by skipping native confirmation popups.

show_preview_androidbooleanoptional

Show a preview page on Android. Improves UX by skipping native confirmation popups.

Tracking

tracking_campaignstringoptional

Campaign name for attribution. Example: "BlackFriday2025".

tracking_sourcestringoptional

Traffic source. Example: "instagram", "newsletter".

tracking_mediumstringoptional

Campaign medium. Example: "cpc", "email", "social".

Request Example

Bash

curl -X POST https://sdk.sqd.link/api/v1/sdk/generate_link \
  -H "PROJECT-KEY: testpr_86a440d502ee6805ea4f0fabf4dc12afxxxxxxxx" \
  -H "ENVIRONMENT: production" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Summer Sale",
    "subtitle": "50% off all items",
    "data": "{\"screen\": \"promo\", \"promo_id\": \"123\"}",
    "tags": "[\"campaign\", \"summer\"]",
    "ios_custom_redirect": {
      "url": "https://example.com/ios",
      "open_app_if_installed": true
    },
    "android_custom_redirect": {
      "url": "https://example.com/android",
      "open_app_if_installed": true
    },
    "desktop_custom_redirect": {
      "url": "https://example.com/desktop"
    },
    "show_preview_ios": true,
    "show_preview_android": false,
    "tracking_campaign": "summer_2025",
    "tracking_source": "instagram",
    "tracking_medium": "social"
  }'

Response

JSON

{
  "link": "https://grov3cf9.sqd.link/2c1e79"
}

Response Fields

linkstring

The generated URL, ready to share or embed.

Notes

Generated links are for server-side use and will not appear in the dashboard. They are designed to be created and shared dynamically.

Keep your PROJECT-KEY secure. If you need to regenerate it, contact us at [email protected].