Skip to main content
PUT
https://api.taap.it
/
v1
/
links
/
{link_id}
Update Link
curl --request PUT \
  --url https://api.taap.it/v1/links/{link_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "original_url": "<string>",
  "code": "<string>",
  "pixel_id": "<string>",
  "app": "<string>",
  "app_logo": "<string>",
  "android_link": "<string>",
  "ios_link": "<string>",
  "windows_link": "<string>",
  "macos_link": "<string>",
  "whatsapp_message": "<string>",
  "metadata": {
    "title": "<string>",
    "description": "<string>",
    "favicon": "<string>",
    "social_image": "<string>"
  },
  "qr_code_options": {
    "size": 123,
    "color": "<string>",
    "background_color": "<string>",
    "logo": "<string>",
    "logo_size": 123,
    "error_correction_level": "<string>"
  },
  "utm_name": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "utm_template_id": "<string>",
  "referrer": "<string>",
  "password": "<string>",
  "password_description": "<string>",
  "excluded_countries": [
    {
      "code": "<string>",
      "label": "<string>",
      "phone": "<string>",
      "suggested": true,
      "lang": "<string>",
      "continent": "<string>"
    }
  ],
  "has_public_stat": true,
  "is_archived": true,
  "expiration_date": "<string>",
  "expiration_click_count": 123
}
'
Update properties of an existing link including URL, password, and expiration settings. Request:
cURL
curl -X PUT 'https://api.taap.it/v1/links/link_987654321' \
  -H 'Authorization: Bearer taapit_your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Marketing Link",
    "description": "Updated description for campaign",
    "original_url": "https://example.com/updated-url",
    "code": "updated-code",
    "app": "UpdatedApp",
    "app_logo": "https://example.com/new-logo.png",
    "android_link": "updatedapp://open?url=https://example.com",
    "ios_link": "updatedapp://open?url=https://example.com",
    "windows_link": "ms-windows-store://pdp/?productid=9NBLGGH987654",
    "macos_link": "macappstore://itunes.apple.com/app/updatedapp/id987654321",
    "whatsapp_message": "Check out this updated link!",
    "metadata": {
      "title": "Updated Product",
      "description": "Check out our updated product",
      "favicon": "https://example.com/new-favicon.ico",
      "social_image": "https://example.com/new-social-image.jpg"
    },
    "qr_code_options": {
      "size": 250,
      "color": "#FF0000",
      "background_color": "#FFFFFF",
      "logo": "https://example.com/new-logo.png",
      "logo_size": 60,
      "error_correction_level": "H"
    },
    "utm_name": "updated_campaign",
    "utm_source": "social",
    "utm_medium": "facebook",
    "utm_campaign": "updated2024",
    "utm_term": "updated_marketing",
    "utm_content": "updated_cta_button",
    "utm_template_id": "template_456",
    "referrer": "https://facebook.com",
    "password": "newpassword123",
    "password_description": "Enter new password to access link",
    "excluded_countries": [
      {
        "code": "CA",
        "label": "Canada",
        "phone": "+1",
        "suggested": false,
        "lang": "en",
        "continent": "North America"
      }
    ],
    "has_public_stat": false,
    "is_archived": false,
    "expiration_date": "2024-06-30T23:59:59Z",
    "expiration_click_count": 500,
    "pixel_id": "pixel_789123456"
  }'
Response: 
{
  "id": "link_987654321",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z",
  "project_id": "project_123456789",
  "domain_id": "domain_987654321",
  "pixel_id": "pixel_789123456",
  "original_url": "https://example.com/updated-url",
  "name": "Updated Marketing Link",
  "description": "Updated description for campaign",
  "code": "updated-code",
  "app": "UpdatedApp",
  "app_logo": "https://example.com/new-logo.png",
  "android_link": "updatedapp://open?url=https://example.com",
  "ios_link": "updatedapp://open?url=https://example.com",
  "windows_link": "ms-windows-store://pdp/?productid=9NBLGGH987654",
  "macos_link": "macappstore://itunes.apple.com/app/updatedapp/id987654321",
  "whatsapp_message": "Check out this updated link!",
  "metadata": {
    "title": "Updated Product",
    "description": "Check out our updated product",
    "favicon": "https://example.com/new-favicon.ico",
    "social_image": "https://example.com/new-social-image.jpg"
  },
  "qr_code_options": {
    "size": 250,
    "color": "#FF0000",
    "background_color": "#FFFFFF",
    "logo": "https://example.com/new-logo.png",
    "logo_size": 60,
    "error_correction_level": "H"
  },
  "utm_name": "updated_campaign",
  "utm_source": "social",
  "utm_medium": "facebook",
  "utm_campaign": "updated2024",
  "utm_term": "updated_marketing",
  "utm_content": "updated_cta_button",
  "utm_template_id": "template_456",
  "referrer": "https://facebook.com",
  "password": "newpassword123",
  "password_description": "Enter new password to access link",
  "excluded_countries": [
    {
      "code": "CA",
      "label": "Canada",
      "phone": "+1",
      "suggested": false,
      "lang": "en",
      "continent": "North America"
    }
  ],
  "has_public_stat": false,
  "is_archived": false,
  "expiration_date": "2024-06-30T23:59:59Z",
  "expiration_click_count": 500,
  "clicks": 42
}

​
Authorization

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

​
Path Parameters

​
link_id
string
required
Unique identifier for the link

​
Request Body

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

​
Core Parameters

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

​
Deep Linking Parameters

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

​
Metadata Parameters

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

​
UTM Parameters

​
utm_name
string
Updated UTM campaign name
​
utm_source
string
Updated UTM source (e.g., email, social, google)
​
utm_medium
string
Updated UTM medium (e.g., newsletter, post, cpc)
​
utm_campaign
string
Updated UTM campaign identifier
​
utm_term
string
Updated UTM term (keywords)
​
utm_content
string
Updated UTM content (e.g., cta_button, banner)
​
utm_template_id
string
Updated UTM template identifier
​
referrer
string
Updated referrer URL

​
Security & Access Parameters

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

​
Status Parameters

​
is_archived
boolean
Updated archive status of the link

​
Expiration Parameters

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