Skip to main content
Version: main (unreleased)

UpdateLinkRequest

destination_urlstring | nullnullable
Example: https://example.com/new/url
titlestring | nullnullable
Example: Updated Title
status object
oneOf
null
expires_atinteger,null<int64>nullable

Expiration timestamp (Unix timestamp in seconds). Set to clear expiration.

Example: 1640995200
clear_expirationboolean | nullnullable

Set to true to clear the expiration date

Example: false
tagsstring[]nullable
Example: ["updated","tag"]
utm_params object
oneOf
null
forward_query_paramsboolean | nullnullable
redirect_typestring | nullnullable

HTTP redirect type: 301 (permanent) or 307 (temporary). Available on Pro+ plans.

Example: 307
ios_urlstring | nullnullable

iOS-specific destination URL (Business tier feature). Set to clear the iOS URL.

Example: https://apps.apple.com/app/id123456789
clear_ios_urlboolean | nullnullable

Set to true to clear the iOS URL

Example: false
android_urlstring | nullnullable

Android-specific destination URL (Business tier feature). Set to clear the Android URL.

Example: https://play.google.com/store/apps/details?id=com.example
clear_android_urlboolean | nullnullable

Set to true to clear the Android URL

Example: false
desktop_urlstring | nullnullable

Desktop-specific destination URL (Business tier feature). Set to clear the Desktop URL.

Example: https://example.com/desktop-app
clear_desktop_urlboolean | nullnullable

Set to true to clear the Desktop URL

Example: false
UpdateLinkRequest
{
  "destination_url": "https://example.com/new/url",
  "title": "Updated Title",
  "status": "null",
  "expires_at": 1640995200,
  "clear_expiration": false,
  "tags": [
    "updated",
    "tag"
  ],
  "utm_params": "null",
  "forward_query_params": true,
  "redirect_type": "307",
  "ios_url": "https://apps.apple.com/app/id123456789",
  "clear_ios_url": false,
  "android_url": "https://play.google.com/store/apps/details?id=com.example",
  "clear_android_url": false,
  "desktop_url": "https://example.com/desktop-app",
  "clear_desktop_url": false
}