Skip to main content
Version: 0.8.0

CreateLinkRequest

destination_urlstringrequired
Example: https://example.com/very/long/url
expires_atinteger,null<int64>nullable
Example: 1640995200
forward_query_paramsboolean | nullnullable
redirect_typestring

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

Example: 301
short_codestring | nullnullable
Example: my-custom-code
tagsstring[]nullable
Example: ["marketing","social"]
titlestring | nullnullable
Example: My Awesome Link
utm_params object
oneOf
null
CreateLinkRequest
{
"destination_url": "https://example.com/very/long/url",
"expires_at": 1640995200,
"forward_query_params": true,
"redirect_type": "301",
"short_code": "my-custom-code",
"tags": [
"marketing",
"social"
],
"title": "My Awesome Link",
"utm_params": "null"
}