links-v2

Create a trackable short link for any URL or SMS offer

post/v2/links/shorten

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/links/shorten
  • Auth: API key in header X-Api-Key

Request body

contactPhonestring

Contact phone number for offer macro substitution

listIdinteger

Sending list ID (alternative to phoneNumber)

metadataobject

Arbitrary key-value pairs for attribution

offerIdstring

SMS Offer ID (from offers collection)

phoneNumberstring

Sending list phone number in E.164 format

urlstring

Raw destination URL to shorten

Response

Link created

destinationUrlstring

Final destination URL

domainstring

Short link domain

filterBotsboolean

Whether bot filtering is enabled

linkIdstring

Short link ID

offerIdstring

Offer ID (if offer mode)

shortUrlstring

Full short URL

Changes

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