latestOpenAPI 3.0.02026-08-202629123.8 KB

351c1f004617

Links

Create or update a link

Create a new shortened link or update an existing one. To create: provide url and workspace_id. To update: provide id and any fields to change. Supports custom slugs, UTM parameters, retargeting pixels, Open Graph metadata, and redirect rules.

post/api/v1/link

Request body

block_botsboolean

block_bots

body_tagsstring

body_tags

cloakingboolean

cloaking

deletedboolean

deleted

domainstring

domain

enabledboolean

enabled

fb_pixel_idstring

fb_pixel_id

forward_paramsboolean

forward_params

ga4_tag_idstring

ga4_tag_id

gtm_idstring

gtm_id

head_tagsstring

head_tags

hide_referrerboolean

hide_referrer

idinteger

Link ID. Required to update an existing link

linkify_wordsstring

linkify_words

namestring

name

notestring

note

og_descriptionstring

og_description

og_imagestring

og_image

og_titlestring

og_title

replacementsstring

replacements

slugstring

slug

spamboolean

spam

tiktok_pixel_idstring

tiktok_pixel_id

urlstring uri

URL. Required to create a new link.

utm_campaignstring

utm_campaign

utm_contentstring

utm_content

utm_mediumstring

utm_medium

utm_sourcestring

utm_source

utm_termstring

utm_term

workspace_idinteger

Workspace ID

Example request

{
  "url": "www.somelink.com",
  "workspace_id": 33
}

Response

Link

fb_pixel_idstring nullable

linkedin_partner_idstring nullable

microsoft_uet_tag_idstring nullable

reddit_pixel_idstring nullable

tiktok_pixel_idstring nullable

hide_referrerboolean nullable

expiry_datetimestring nullable

expiry_destinationstring uri nullable

twitter_pixel_idstring nullable

cloakingboolean nullable

linkify_wordsstring nullable

full_urlstring uri

og_descriptionstring nullable

skip_social_crawler_trackingboolean nullable

body_tagsstring nullable

og_titlestring nullable

notestring nullable

namestring nullable

idinteger nullable

gtm_idstring nullable

og_imagestring nullable

block_botsboolean nullable

snapchat_pixel_idstring nullable

utm_contentstring nullable

enabledboolean nullable

urlstring uri

replacementsstring nullable

deletedboolean nullable

qr_stylesobject nullable

webhooksstring[] nullable

created_by_user_idinteger nullable

expiry_clicksinteger nullable

notify_slackboolean nullable

notify_user_idsinteger[] nullable

workspace_idinteger nullable

public_analyticsboolean nullable

pinterest_tag_idstring nullable

passwordstring 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

Example response

{
  "fb_pixel_id": null,
  "linkedin_partner_id": null,
  "microsoft_uet_tag_id": null,
  "reddit_pixel_id": null,
  "tiktok_pixel_id": null,
  "hide_referrer": null,
  "expiry_datetime": null,
  "expiry_destination": null,
  "rules": [],
  "twitter_pixel_id": null,
  "cloaking": null,
  "linkify_words": null,
  "full_url": "http://localhost:4000U",
  "og_description": null,
  "body_tags": null,
  "og_title": null,
  "note": null,
  "name": null,
  "id": 30,
  "gtm_id": null,
  "og_image": null,
  "block_bots": null,
  "snapchat_pixel_id": null,
  "utm_content": null,
  "enabled": null,
  "url": "https://www.somelink.com",
  "replacements": null,
  "deleted": null,
  "created_by_user_id": 7,
  "expiry_clicks": null,
  "workspace_id": 42,
  "public_analytics": null,
  "pinterest_tag_id": null,
  "utm_source": null,
  "slug": null,
  "domain": null,
  "forward_params": null,
  "utm_medium": null,
  "head_tags": null,
  "ga4_tag_id": null,
  "utm_term": null,
  "utm_campaign": null
}