latestOpenAPI 3.0.02026-08-202629123.8 KB

351c1f004617

Links

Create or update multiple links

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 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

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'