Skip to content

Build Tracked Link

POST
/visitors/links/build

Mint a tracked short link for a destination URL.

Gated on signals:run, NOT signals:read - this mints a durable public URL that attributes real traffic, which is why the app puts it behind the run grant rather than the read one.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mint a tracked short link.

object
contact_id
Any of:
integer
destination_url
required

Absolute http(s) URL the link points at.

string
link_name
required

Display name. REQUIRED, and not cosmetic: clicks are GROUPED by it, so two links sharing a name report as one.

string
>= 1 characters <= 120 characters
params

Static custom params baked into the token.

object
key
additional properties
string
placement

Where the token goes when NOT shortened: fragment (#t=...) or query (?g8t=...). Ignored when shorten is true.

string
default: fragment /^(fragment|query)$/
shorten

Mint the LinkedIn-safe short form ({base}/t/{token}) for surfaces that strip fragments and query params.

boolean
stream_id
Any of:
string
<= 64 characters

Responses

201

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string