Skip to main content
PUT
Update Link
Update properties of an existing link including URL, password, and expiration settings. Request:
cURL
Response:

Authorization

string
required
Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Path Parameters

Unique identifier for the link

Request Body

All parameters are optional for updates. Only include the fields you want to update.

Core Parameters

string
Updated name for the link
string
Updated description for the link
string
Updated URL to be shortened. Supports http, https, mailto, tel, sms, whatsapp, tg, skype schemes.
string
Updated short code for the link
string
Updated tracking pixel ID to associate with this link
string
Updated project ID to associate with this link

Deep Linking Parameters

string
Updated name of the mobile app for deep linking
Updated URL to the app logo image
Updated Android deep link URL (e.g., myapp://open?url=…)
Updated iOS deep link URL (e.g., myapp://open?url=…)
Updated Windows deep link URL (e.g., ms-windows-store://…)
Updated macOS deep link URL (e.g., macappstore://…)
string
Updated pre-filled message for WhatsApp sharing

Metadata Parameters

object
Updated link metadata for website previews
object
Updated QR code generation options

UTM Parameters

string
Updated UTM campaign name
string
Updated UTM source (e.g., email, social, google)
string
Updated UTM medium (e.g., newsletter, post, cpc)
string
Updated UTM campaign identifier
string
Updated UTM term (keywords)
string
Updated UTM content (e.g., cta_button, banner)
string
Updated UTM template identifier
string
Updated referrer URL

Security & Access Parameters

string
Updated password to protect the link (requires plan feature)
string
Updated description shown when password is required
array
Updated array of countries to exclude from accessing the link
boolean
Updated setting for whether link statistics are publicly accessible

Conversion Tracking Parameters

boolean
Updated setting for whether conversion tracking is enabled on this link

Status Parameters

boolean
Updated archive status of the link

Expiration Parameters

string
Updated ISO 8601 datetime when link expires (requires plan feature)
integer
Updated maximum number of clicks before link expires (requires plan feature)