Core fields

Field	Type	Rules
link	URL	Required; maximum 2048 characters
reference	string	Lowercase letters, digits and hyphens; maximum 255
subdomain	string	5–63 characters; lowercase letters, digits and internal hyphens
custom_domain	hostname	Owned and verified by the API-key account

Optional fields

fallback_url, apn, ios_store_url, preview fields st/sd/si, active_from, expires_at, click_limit, and expiration_redirect_url.

Nested model: parameters[]

{
  "name": "utm_source",
  "value": "newsletter"
}

name is limited to 50 characters and value to 255. Campaign parameters depend on the account plan.

Nested model: device_targets[]

{
  "device": "android",
  "url": "https://example.com/android"
}

Supported values are windows, macos, linux, ubuntu, ios, iphone, ipad, android, blackberry, and other.

Verified-domain response

{
  "domains": [{
    "id": 12,
    "domain": "go.example.com",
    "status": "verified",
    "verified_at": "2026-08-21T10:15:30.000000Z",
    "links_count": 8
  }]
}