create_link
Create short links and URL shorteners. Use this when the user asks to shorten a URL, create a short link, or make a link shorter.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The destination URL for the link (required) | |
| name | No | A nickname for the link to identify it later | |
| note | No | A private note about this link | |
| slug | No | Custom slug/suffix for the link (must start with /). Only valid together with domain: setting slug without a workspace-owned domain is rejected by the API. | |
| domain | No | Custom domain for the short link (without trailing /). Must be a domain that already belongs to this workspace — call list_domains to get valid values. Required whenever slug is set. | |
| gtm_id | No | Google Tag Manager container ID | |
| enabled | No | Whether the link is active (default: true) | |
| cloaking | No | Hide destination URL by opening in an iframe | |
| og_image | No | Open Graph image URL for social media previews | |
| og_title | No | Open Graph title for social media previews | |
| utm_term | No | UTM term parameter | |
| block_bots | No | Block known bots and spiders from following the link | |
| ga4_tag_id | No | Google Analytics 4 tag ID | |
| utm_medium | No | UTM medium parameter | |
| utm_source | No | UTM source parameter | |
| fb_pixel_id | No | Meta/Facebook Pixel ID for tracking | |
| utm_content | No | UTM content parameter | |
| utm_campaign | No | UTM campaign parameter | |
| hide_referrer | No | Hide referrer information when users click | |
| forward_params | No | Forward URL parameters to the destination | |
| og_description | No | Open Graph description for social media previews | |
| expiry_datetime | No | ISO 8601 datetime when the link should expire | |
| expiry_destination | No | Fallback URL after expiry (404 if blank) |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Link ID | |
| url | No | Destination URL | |
| name | No | ||
| note | No | ||
| slug | No | ||
| rules | No | ||
| domain | No | ||
| gtm_id | No | ||
| deleted | No | ||
| enabled | No | ||
| cloaking | No | ||
| full_url | No | Full short-link URL | |
| og_image | No | ||
| og_title | No | ||
| password | No | ||
| utm_term | No | ||
| webhooks | No | ||
| body_tags | No | ||
| head_tags | No | ||
| qr_styles | No | ||
| block_bots | No | ||
| ga4_tag_id | No | ||
| utm_medium | No | ||
| utm_source | No | ||
| fb_pixel_id | No | ||
| utm_content | No | ||
| notify_slack | No | ||
| replacements | No | ||
| utm_campaign | No | ||
| workspace_id | No | ||
| expiry_clicks | No | ||
| hide_referrer | No | ||
| linkify_words | No | ||
| forward_params | No | ||
| og_description | No | ||
| expiry_datetime | No | ||
| notify_user_ids | No | ||
| reddit_pixel_id | No | ||
| tiktok_pixel_id | No | ||
| pinterest_tag_id | No | ||
| public_analytics | No | ||
| twitter_pixel_id | No | ||
| snapchat_pixel_id | No | ||
| created_by_user_id | No | ||
| expiry_destination | No | ||
| linkedin_partner_id | No | ||
| microsoft_uet_tag_id | No | ||
| skip_social_crawler_tracking | No |