Skip to content

Documentation

Short-Link Resolution

Resolve a public URL already received by the SDK into a full route payload.

When to use

Short-link resolution is an SDK-side API lookup. It turns a single-segment public URL (already received by the app via Universal Link or App Link) into a resolved route payload with pathname, params, and metadata.

Short-link resolution is not public browser routing. It is an authenticated SDK lookup for a URL the app already has.

Request

json
POST /api/v1/sdk/short-link/resolve
Authorization: Bearer pk_live_xxx

{
  "appID": "app_abc123",
  "url": "https://go.customer.com/summer"
}

Response

json
{
  "ok": true,
  "link": {
    "type": "verified",
    "url": "https://go.customer.com/summer",
    "pathname": "/offers/summer",
    "params": { "campaign": "summer" },
    "metadata": { "linkId": "link_123" }
  }
}

The SDK App ID determines which Link Target platform is selected. If no matching target exists, the response returns ok: false with a reason.