PATCH/api/v6/urlshortener/links/{domain}/{code}

Update a short link

Change the state, the expiry or the destination. The code is immutable.

Scope

API key with the urlshortener service enabled

Usage limit

35 requests per second

Updates the active state, the expiresAt date (send null to clear it) or the destination longUrl, which is revalidated. The code or alias is immutable. At least one field is required.

Path parameters

domain

stringrequired

Domain of the link.

code

stringrequired

Short code or alias (lowercase).

Request body

application/json

active

booleanoptional

Enables or disables the link.

expiresAt

stringoptional

New expiry, or null to clear it.

longUrl

stringoptional

New destination URL. Revalidated as on creation.

{
  "active": false
}

Responses

200

Link updated.

{
  "success": true,
  "data": {
    "id": 1024,
    "code": "a1b2c3d",
    "domain": "go.acme.co",
    "shortUrl": "https://go.acme.co/a1b2c3d",
    "longUrl": "https://example.com/landing?utm_source=sms",
    "alias": false,
    "active": true,
    "expiresAt": null,
    "createdAt": "2026-06-01T15:04:05Z",
    "clicks": 0,
    "uniqueClicks": 0,
    "lastClickAt": null
  },
  "meta": {
    "requestId": "8f0c0e2a4b1d4c8fae2b7a91e0c5d3f6",
    "timestamp": "2026-06-01T15:04:05+00:00",
    "responseTimeMs": 7.2
  }
}

400

Nothing to update, or an invalid field.

401

Invalid or missing credentials.

404

No link with that domain and code.

429

Request limit exceeded.

Possible errors

Codes this endpoint can return in error.code. The full detail lives in the catalog.

401AUTH_REQUIREDNo Bearer token was sent, and every call requires one.401AUTH_INVALID_KEYThe API key is not recognized: wrong format, revoked or expired.401AUTH_SERVICE_NOT_ALLOWEDThe key is not allowed to use the service behind this endpoint.403ACCOUNT_READ_ONLYRead-only mode: only GET, HEAD and OPTIONS pass.400NOTHING_TO_UPDATENo updatable fields were sent.400URL_INVALIDThe destination URL is malformed.400URL_SCHEME_NOT_ALLOWEDOnly http/https destinations are allowed.400URL_TOO_LONGThe destination URL exceeds the maximum length.400URL_BLOCKED_HOSTThe destination host is private or reserved.400EXPIRES_AT_INVALIDexpiresAt must be a future ISO date-time.404LINK_NOT_FOUNDNo link with that domain and code.429RATE_TPS_EXCEEDEDYou exceeded your organization quota for this endpoint.

See the full catalog

Scope and limits

Path parameters

Request body

Responses

Possible errors