CreateLinkRequest

destination_urlstringrequired

Example: https://example.com/very/long/url

short_codestring | nullnullable

Example: my-custom-code

titlestring | nullnullable

Example: My Awesome Link

expires_atinteger,null<int64>nullable

Example: 1640995200

tagsstring[]nullable

Example: ["marketing","social"]

utm_params object

oneOf

• null
• UtmParams

null

forward_query_paramsboolean | nullnullable

redirect_typestring

HTTP redirect type: 301 (permanent) or 307 (temporary). Default is 301, available on Pro+ plans.

Example: 301

ios_urlstring | nullnullable

iOS-specific destination URL (Business tier feature).

Example: https://apps.apple.com/app/id123456789

android_urlstring | nullnullable

Android-specific destination URL (Business tier feature).

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

desktop_urlstring | nullnullable

Desktop-specific destination URL (Business tier feature).

Example: https://example.com/desktop-app

custom_domainstring | nullnullable

Custom domain to associate this link with (must be an active domain on the org). Immutable after creation. None = use default short domain.

Example: go.mybrand.com

CreateLinkRequest

{
  "destination_url": "https://example.com/very/long/url",
  "short_code": "my-custom-code",
  "title": "My Awesome Link",
  "expires_at": 1640995200,
  "tags": [
    "marketing",
    "social"
  ],
  "utm_params": "null",
  "forward_query_params": true,
  "redirect_type": "301",
  "ios_url": "https://apps.apple.com/app/id123456789",
  "android_url": "https://play.google.com/store/apps/details?id=com.example",
  "desktop_url": "https://example.com/desktop-app",
  "custom_domain": "go.mybrand.com"
}