Skip to main content
Version: 0.7.0

Link

click_countinteger<int64>required
Example: 42
created_atinteger<int64>required
Example: 1609459200
created_bystringrequired
Example: user-123
destination_urlstringrequired
Example: https://example.com/very/long/url
expires_atinteger,null<int64>nullable
Example: 1640995200
forward_query_paramsboolean | nullnullable

Whether to forward visitor query params to the destination (Pro+ only). None = use org default (resolved at KV write time).

idstringrequired
Example: link-123456
org_idstringrequired
Example: org-789
redirect_typestringrequired

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

Example: 301
short_codestringrequired
Example: abc123
statusLinkStatus (string)required

Possible values: [active, disabled, blocked]

tagsstring[]required
Example: ["marketing","social"]
titlestring | nullnullable
Example: My Awesome Link
updated_atinteger,null<int64>nullable
Example: 1609459300
utm_params object
oneOf
null
Link
{
"click_count": 42,
"created_at": 1609459200,
"created_by": "user-123",
"destination_url": "https://example.com/very/long/url",
"expires_at": 1640995200,
"forward_query_params": true,
"id": "link-123456",
"org_id": "org-789",
"redirect_type": "301",
"short_code": "abc123",
"status": "active",
"tags": [
"marketing",
"social"
],
"title": "My Awesome Link",
"updated_at": 1609459300,
"utm_params": "null"
}