Short Links REST API
Create, retrieve, update, and revoke short links via signed HTTP requests.
https://taqlyn.com/shop/checkout?cartId=cart_9841&promo=WELCOME20&aff=partner_8The Short Links API manages the creation and lifecycle of routing URLs. All endpoints on /v1/short-links require Ed25519 Request Signing.
#Create Short Link
POST /v1/short-links
Generates a new short link, warms the edge cache, and registers routing destinations for Universal Links and Deferred Deep Linking.
#Headers
| Header | Type | Description |
|---|---|---|
Content-Type | string | Must be application/json. |
X-Taqlyn-Client-Id | string | app_test_* or app_live_*. |
X-Taqlyn-Timestamp | string | Current Unix timestamp in seconds. |
X-Taqlyn-Signature | string | Hex-encoded Ed25519 signature of the request. |
#Request Body
{
"destinationWeb": "https://example.com/products/491?promo=SUMMER",
"destinationPath": "/products/491",
"params": {
"sku": "491",
"promo": "SUMMER",
"referrer": "influencer_mike"
},
"mode": "deferred_app",
"ogTitle": "Special Summer Offer",
"ogDescription": "Get 20% off with exclusive in-app savings.",
"ogImage": "https://example.com/assets/og-summer.jpg"
}#Parameters Reference
| Field | Type | Required | Description |
|---|---|---|---|
destinationWeb | string | Yes | Absolute HTTPS fallback URL when app is not installed or opened on desktop. |
destinationPath | string | No | Deep link route inside your mobile application (e.g. /checkout/cart). |
params | object | No | Key-value dictionary passed to mobile routing handlers upon app launch. |
mode | string | No | "deferred_app" (default), "web_only", or "app_only". |
ogTitle | string | No | Open Graph meta title for iMessage, WhatsApp, Slack previews. |
ogDescription | string | No | Open Graph snippet description. |
ogImage | string | No | Open Graph image URL (1200x630 recommended). |
#Response (201 Created)
{
"id": "sl_9128abef",
"code": "summer24",
"shortUrl": "https://taqlyn.com/summer24",
"host": "taqlyn.com",
"mode": "deferred_app",
"destinationWeb": "https://example.com/products/491?promo=SUMMER",
"destinationPath": "/products/491",
"params": {
"sku": "491",
"promo": "SUMMER",
"referrer": "influencer_mike"
},
"env": "production",
"orgId": "org_5821038",
"appId": "app_live_8f92ab140cd3",
"createdAt": "2026-09-05T12:00:00Z"
}#Get Short Link
GET /v1/short-links/{id}
Retrieves the configuration and current status of a previously generated short link.
#Path Parameters
id: Unique short link identifier (e.g.sl_9128abef).
#Response (200 OK)
{
"id": "sl_9128abef",
"code": "summer24",
"shortUrl": "https://taqlyn.com/summer24",
"mode": "deferred_app",
"destinationWeb": "https://example.com/products/491?promo=SUMMER",
"destinationPath": "/products/491",
"params": {
"sku": "491",
"promo": "SUMMER"
},
"clicksCount": 1420,
"resolvesCount": 892,
"createdAt": "2026-09-05T12:00:00Z"
}#Update Short Link
PATCH /v1/short-links/{id}
Dynamically modifies destination routes or parameters without invalidating printed QR codes or distributed links.
#Request Body
{
"destinationWeb": "https://example.com/products/491-v2",
"destinationPath": "/products/491/upgraded",
"params": {
"sku": "491",
"campaign": "extended_sale"
}
}#Response (200 OK)
Returns the updated ShortLinkResponse object. The edge routing cache is invalidated immediately worldwide within ~150ms.
#Delete / Revoke Short Link
DELETE /v1/short-links/{id}
Deactivates the short link. Subsequent visits will route to your organization's fallback domain or return a 404 status.
#Response (204 No Content)
An empty response with HTTP status code 204.