Skip to main content
POST
/
v1
/
links
Create Link
curl --request POST \
  --url https://api.taap.it/v1/links \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "original_url": "<string>"
}
'
{
  "detail": "Invalid URL format"
}

Documentation Index

Fetch the complete documentation index at: https://docs.taap.it/llms.txt

Use this file to discover all available pages before exploring further.

Create a new deeplink with custom codes, domains, password protection, expiration dates, and tracking features. Request:
cURL
curl -X POST 'https://api.taap.it/v1/links' \
  -H 'Authorization: Bearer taapit_your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "original_url": "https://example.com/very-long-url-that-needs-shortening"
  }'
Response: 
{
  "id": "link_987654321",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "project_id": "project_123456789",
  "domain_id": "domain_987654321",
  "pixel_id": "pixel_456789123",
  "original_url": "https://example.com/very-long-url-that-needs-shortening",
  "name": "My Marketing Link",
  "description": "Link for summer campaign",
  "code": "summer2024",
  "app": "MyApp",
  "app_logo": "https://example.com/logo.png",
  "android_link": "myapp://open?url=https://example.com",
  "ios_link": "myapp://open?url=https://example.com",
  "windows_link": "ms-windows-store://pdp/?productid=9NBLGGH123456",
  "macos_link": "macappstore://itunes.apple.com/app/myapp/id123456789",
  "whatsapp_message": "Check out this amazing link!",
  "metadata": {
    "title": "Amazing Product",
    "description": "Check out our new product",
    "favicon": "https://example.com/favicon.ico",
    "social_image": "https://example.com/social-image.jpg"
  },
  "qr_code_options": {
    "size": 200,
    "color": "#000000",
    "background_color": "#ffffff",
    "logo": "https://example.com/logo.png",
    "logo_size": 50,
    "error_correction_level": "M"
  },
  "utm_name": "summer_campaign",
  "utm_source": "email",
  "utm_medium": "newsletter",
  "utm_campaign": "summer2024",
  "utm_term": "marketing",
  "utm_content": "cta_button",
  "utm_template_id": "template_123",
  "referrer": "https://example.com",
  "password": "secure123",
  "password_description": "Enter password to access link",
  "excluded_countries": [
    {
      "code": "US",
      "label": "United States",
      "phone": "+1",
      "suggested": true,
      "lang": "en",
      "continent": "North America"
    }
  ],
  "has_public_stat": true,
  "is_archived": false,
  "expiration_date": "2024-12-31T23:59:59Z",
  "expiration_click_count": 1000,
  "clicks": 0
}

​
Authorization

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

​
Request Parameters

​
original_url
string
required
The URL to be shortened. Supports http, https, mailto, tel, sms, whatsapp, tg, skype schemes.

​
Response Fields

​
Core Fields

​
id
string
required
Unique identifier for the created link
​
created_at
string
required
ISO 8601 timestamp when the link was created
​
updated_at
string
required
ISO 8601 timestamp when the link was last updated
​
project_id
string
ID of the associated project
​
domain_id
string
ID of the custom domain used
​
pixel_id
string
ID of the associated tracking pixel

​
Link Content

​
original_url
string
required
The original URL that was shortened
​
name
string
Name of the link
​
description
string
Description of the link
​
code
string
required
The short code used in the URL

​
Deep Linking

​
app
string
Name of the mobile app for deep linking
URL to the app logo image
​
android_link
string
Android deep link URL
​
ios_link
string
iOS deep link URL
​
windows_link
string
Windows deep link URL
​
macos_link
string
macOS deep link URL
​
whatsapp_message
string
Pre-filled message for WhatsApp sharing

​
Metadata & QR Code

​
metadata
object
Link metadata for website previews
​
qr_code_options
object
QR code generation options

​
UTM Parameters

​
utm_name
string
UTM campaign name
​
utm_source
string
UTM source
​
utm_medium
string
UTM medium
​
utm_campaign
string
UTM campaign identifier
​
utm_term
string
UTM term (keywords)
​
utm_content
string
UTM content
​
utm_template_id
string
UTM template identifier
​
referrer
string
Referrer URL

​
Security & Access

​
password
string
Password to protect the link
​
password_description
string
Description shown when password is required
​
excluded_countries
array
Array of countries excluded from accessing the link
​
has_public_stat
boolean
Whether link statistics are publicly accessible

​
Status Flags

​
is_archived
boolean
Whether the link is archived

​
Expiration

​
expiration_date
string
ISO 8601 datetime when link expires
​
expiration_click_count
integer
Maximum number of clicks before link expires

​
Analytics

​
clicks
integer
Total number of clicks

​
Error Responses

{
  "detail": "Invalid URL format"
}