Links

Create or update multiple links

Changed on Sep 15, 2026

Create or update up to 1000 links in one request. The body is a JSON array where each item uses the same schema as POST /api/v1/link — include id to update, omit it to create, and provide workspace_id per item (required for API-key auth; ignored for OAuth, whose token is scoped to a single workspace). Returns one result per item and responds 200 even if some items fail — inspect each item's status.

post/api/v1/links

Request

Base URL
https://api.linklyhq.com
Auth
- API key in query parameter api_key
- or HTTP bearer
TypeScript
https://skmtc.dev/linklyhq/apis/linkly-url-shortener-api/docs/api/v1/links/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

fb_pixel_idstring

fb_pixel_id

tiktok_pixel_idstring

tiktok_pixel_id

hide_referrerboolean

hide_referrer

expiry_datetimestring date-time

When the link expires (ISO 8601). After this time visitors are sent to expiry_destination. The year must be between 2000 and 2100.

expiry_destinationstring uri

Where visitors are sent once the link has expired (by date or by click count). Must start with http.

cloakingboolean

cloaking

linkify_wordsstring

linkify_words

og_descriptionstring

og_description

body_tagsstring

body_tags

spamboolean

spam

og_titlestring

og_title

notestring

note

namestring

name

idinteger

Link ID. Required to update an existing link

gtm_idstring

gtm_id

og_imagestring

og_image

block_botsboolean

block_bots

utm_contentstring

utm_content

enabledboolean

enabled

urlstring uri

URL. Required to create a new link.

replacementsstring

replacements

deletedboolean

deleted

expiry_clicksinteger

Expire the link after this many clicks; visitors are then sent to expiry_destination.

workspace_idinteger

Workspace ID

utm_sourcestring

utm_source

slugstring

slug

domainstring

domain

forward_paramsboolean

forward_params

utm_mediumstring

utm_medium

head_tagsstring

head_tags

ga4_tag_idstring

ga4_tag_id

utm_termstring

utm_term

utm_campaignstring

utm_campaign

Example request

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

Response

Results

errorobject

Error detail (present when status is error)

indexinteger

0-based position in the request array

linkobject

The created or updated link (present when status is success)

status'success' | 'error'

Changes

Sep 15, 20269c5b6c116b85 Revision 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)
- 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)
- 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)

Operation history