Dynamo Developer DocsDynamo Developer Docs
External APISuperlinks

Update (retarget) a superlink

Update `name`, `redirectLink`, and/or `redirectLinkName` — at least one. Changing `redirectLink` **retargets** the link: the short URL never changes, so an already-distributed link starts redirecting to the new target immediately. Whitelisted fields only — unknown fields are rejected.

patch/superlinks/{superlinkId}

Beta

The External API is in beta. Endpoints, parameters, and response shapes may change — including breaking changes — in future releases. Pin to documented behavior before relying on it in production.

Authorization

x-api-key x-date x-signature x-api-version
x-api-key<token>

Your API key (the ApiKeys document id).

In: header

x-date<token>

Current timestamp as an IMF-fixdate string (GMT, US locale) "EEE, dd MMM yyyy HH:mm:ss z", e.g. "Sun, 06 Dec 2020 12:59:11 GMT". 30-second TTL.

In: header

x-signature<token>

HMAC-SHA256 of the x-date string keyed by your secret, lowercase hex.

In: header

x-api-version<token>

API version you're coding against — currently 1. Required; a missing or unsupported value returns 400 with Missing or unsupported x-api-version header. Supported versions: 1.

In: header

Path Parameters

superlinkId*string

The superlink id (the trailing segment of the short URL).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

At least one field is required. Unknown fields are rejected.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Try it

live — writes real data

Kept in this tab only and signed in your browser — your secret never leaves your device.

Path

Body

This sends a real PATCH to your live organization.

Enter your key and secret to send.

curl -X PATCH "https://example.com/superlinks/abc12" \  -H "Content-Type: application/json" \  -d '{    "redirectLink": "https://store.example.com/autumn"  }'
{  "id": "abc12",  "name": "Summer Sale",  "active": true,  "superlink": "https://l.dynamo.fyi/brand/abc12",  "redirectLink": "https://store.example.com/summer",  "redirectLinkName": "Store — summer landing",  "workspaceId": "ws_123",  "created": "2026-08-20T09:00:00.000Z",  "createdTimestamp": 1787475600000}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "error": [    {      "message": "string",      "path": [        "string"      ],      "type": "string",      "context": {}    }  ]}

Create a superlink

Create a superlink: mint a new short URL that 302-redirects to `redirectLink` and counts every click. The target may be a web URL (`https://…`) or an **app deep link** (`myapp://daily-bonus`) — the short URL itself is always plain `https`, so it stays shareable anywhere web links are required while still landing the click inside an app. `workspaceId` is **required by design** — every link created here lands in a workspace so it shows up on that workspace's in-app SuperLinks page. When `name` is omitted it's auto-generated as `Short Link <id>`.

Delete a superlink

Soft delete, same semantics as the in-app delete: the short URL immediately stops redirecting and the link leaves every list. **Terminal** — a deleted link `404`s on all subsequent `GET`/`PATCH`/`DELETE` calls; there is no un-delete. Returns the item with `active: false`.