links

Create a governed short link

Requires a token with the links:write permission.

post/api/v1/links

Request

  • Base URL: https://app.utmkit.co
  • URL: https://app.utmkit.co/api/v1/links
  • Auth: HTTP bearer

Request body

android_urlstring nullable

optional Android destination (spec 047): an app link or a Play page, https only; phones on Android are routed here, blank clears it

campaign_idinteger nullable
destinationstring uri nullable
domainstring

optional; a verified custom domain name, else the shared domain

expires_atstring date-time nullable
ios_urlstring nullable

optional iOS destination (spec 047): an app link or an App Store page, https only; phones on iOS are routed here, blank clears it

notestring nullable

free text kept on the link; blank clears it

short_codestring

optional; random when omitted

tagsstring[]

tag names (spec 039): an existing tag of the workspace by name, case-insensitive, else a new one; on update the list replaces the link's tags and [] clears them

utm_campaignstring
utm_contentstring
utm_mediumstring
utm_sourcestring
utm_termstring
whatsapp_messagestring nullable

the prefilled message, plain text, never URL-encoded

whatsapp_numberstring nullable

a WhatsApp click-to-chat link (issue #202): the phone in international format (+, spaces and dashes are stripped). Given INSTEAD of destination — the wa.me URL is composed and the message encoded once, server-side

Response

Link

android_urlstring nullable
campaign_idinteger nullable
created_atstring date-time
destinationstring
expires_atstring date-time nullable
idinteger
ios_urlstring nullable
notestring nullable
qr_urlstring uri

the short URL with the scan marker

short_codestring
short_urlstring uri
state'live' | 'pending' | 'blocked' | 'expired'
utm_campaignstring nullable
utm_contentstring nullable
utm_mediumstring nullable
utm_sourcestring nullable
utm_termstring nullable
warningstring nullable

governance warning when the convention warns rather than blocks

Changes

No recorded changes to this operation across all 1 revision of this API.