LIlinklyhq
Links

Create or update a link

Changed on

Create a new link or update an existing one. Include an 'id' field to update an existing link. Can also accept an array of links for batch operations.

post/api/v1/workspace/{workspace_id}/links

Request

Path parameters

workspace_idstring required

The id of the Workspace

Request body

fb_pixel_idstring nullable

Facebook Pixel ID

tiktok_pixel_idstring nullable

TikTok Pixel ID

hide_referrerboolean

Hide referrer from destination

expiry_datetimestring date-time nullable

Link expiration date/time

expiry_destinationstring nullable

Redirect URL after expiry

domain_idinteger

Domain ID (alternative to domain name)

cloakingboolean

Enable link cloaking

linkify_wordsstring nullable

Words to linkify

sticky_rotatorboolean

Rotator links only: send a returning visitor to the same destination as last time, remembered in a cookie for 30 days. Not available on privacy-mode links; turning privacy mode on switches it off.

og_descriptionstring nullable

Open Graph description

skip_social_crawler_trackingboolean

Skip tracking social media crawlers

body_tagsstring nullable

Custom HTML tags for body

og_titlestring nullable

Open Graph title

notestring nullable

Private note about this link

namestring nullable

Nickname for the link

idinteger

Link ID (include to update existing link)

gtm_idstring nullable

Google Tag Manager ID

og_imagestring nullable

Open Graph image URL

block_botsboolean

Block bot traffic

utm_contentstring nullable
enabledboolean

Whether the link is active

privacy_modeboolean

Record clicks without personal data (no IP, location, network, user agent, referrer or query parameters; click times kept to the hour). Turning it on also clears tracking pixels, custom scripts, conversion tracking, webhooks and click notifications on the link, and click webhooks stop firing for it. Paid plans only.

urlstring uri required

The destination URL

replacementsstring nullable

URL parameter replacements

qr_stylesobject nullable

QR code styling options

webhooksstring[]

Webhook URLs

expiry_clicksinteger nullable

Expire link after this many clicks

public_analyticsboolean

Make analytics publicly accessible

utm_sourcestring nullable
slugstring nullable

Custom slug (must start with /)

domainstring nullable

Custom domain (without trailing /)

forward_paramsboolean

Forward query parameters to destination

utm_mediumstring nullable
head_tagsstring nullable

Custom HTML tags for head

ga4_tag_idstring nullable

Google Analytics 4 Tag ID

utm_termstring nullable
utm_campaignstring nullable

Example request

{
  "rules": [
    {}
  ]
}

Response

Link

fb_pixel_idstring nullable
human_clicks_totalinteger

Lifetime clicks with no bot signal — the subset of clicks_total where neither a bot user-agent nor a verified-bot category was detected. Recorded from 2019 onward.

sparklineinteger[]

Daily human clicks over the last 30 days, oldest first.

clicks_thirty_daysinteger

Clicks in the last 30 days, including bot traffic.

tiktok_pixel_idstring nullable
hide_referrerboolean nullable
cloakingboolean nullable
linkify_wordsstring nullable
full_urlstring uri
clicks_todayinteger

Clicks so far today (UTC), including bot traffic.

og_descriptionstring nullable
body_tagsstring nullable
og_titlestring nullable
notestring nullable
namestring nullable
idinteger nullable
gtm_idstring nullable
og_imagestring nullable
block_botsboolean nullable
clicks_totalinteger

Lifetime clicks, including bot traffic.

human_clicks_thirty_daysinteger

Clicks in the last 30 days with no bot signal — the subset of clicks_thirty_days.

utm_contentstring nullable
human_clicks_todayinteger

Clicks so far today (UTC) with no bot signal.

enabledboolean nullable
urlstring uri
replacementsstring nullable
deletedboolean nullable
workspace_idinteger nullable
public_analyticsboolean nullable
utm_sourcestring nullable
slugstring nullable
domainstring nullable
forward_paramsboolean nullable
utm_mediumstring nullable
head_tagsstring nullable
ga4_tag_idstring nullable
utm_termstring nullable
utm_campaignstring nullable
human_clicks_previous_dayinteger

Clicks yesterday (UTC) with no bot signal.

Example response

{
  "rules": [
    {}
  ]
}

Changes

  • 968598ef7055Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

  • 0370e4bf1074Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)