Create a link

Creates a tracking link. Only name and destinationUrl are required; everything else has a sensible default. The slug is generated when you omit it.

POSThttps://api.clicklookup.com/v1/links

Requires an API key

Request body24

destinationUrlstring · urlrequired
Absolute http(s) URL
namestringrequired
Display name, shown in the dashboard and reports.
1–120 chars
backupUrlstring · urlnullable
Absolute http(s) URL
blankReferrerbooleannullable
blockedUrlstring · urlnullable
Absolute http(s) URL
campaignstringnullable
max 120 chars
capsobjectnullable
Show 4 child attributesHide child attributes
- maxRawintegernullable
  1–9007199254740990
- maxRawDailyintegernullable
  1–9007199254740990
- maxUniqueintegernullable
  1–9007199254740990
- maxUniqueDailyintegernullable
  1–9007199254740990
cloakobjectnullable
Show 4 child attributesHide child attributes
- descriptionstringnullable
  max 300 chars
- enabledboolean
  Whether the item is active.
  Default false
- imageUrlstring · urlnullable
  Absolute http(s) URL
- titlestringnullable
  max 120 chars
costnumbernullable
min 0
costTypeenumnullable
One oftotalcpccpcRawcpacpsdailymonthly
disablePixelsbooleannullable
domainIdstring · uuidnullable
filtersobjectnullable
Show 8 child attributesHide child attributes
- blockedIpenum
  Matches the workspace IP block list
  One ofoffflagblockDefault "block"
- datacenterenum
  Hosting / cloud ASN — servers, not people
  One ofoffflagblockDefault "flag"
- noCookieenum
  Advanced: visitor refused the cookie
  One ofoffflagblockDefault "off"
- noJsenum
  Advanced: visitor never ran the beacon
  One ofoffflagblockDefault "off"
- proxyenum
  Known anonymous proxy / VPN exit
  One ofoffflagblockDefault "flag"
- serverenum
  Scripted clients: curl, python-requests…
  One ofoffflagblockDefault "flag"
- spiderenum
  Search-engine and social crawlers
  One ofoffflagblockDefault "block"
- velocityenum
  30+ clicks from one visitor within a minute
  One ofoffflagblockDefault "flag"
funnelEntrybooleannullable
groupIdstring · uuidnullable
Group to file this under; null for none.
notesstringnullable
max 2000 chars
pixelIdsarray of strings · uuidnullable
Retargeting pixels fired on the interstitial.
max 20 items
redirectTypeenumnullable
HTTP status used for the redirect.
One of301302307
rulesarray of objectsnullable
max 50 items
Show 5 child attributesHide child attributes
- actionobjectrequired
  What to do.
  Show 2 child attributesHide child attributes
  typeenumrequired
  One ofredirectblockpass
  urlstring · urlnullable
  Required when type = redirect
- conditionsarray of objectsrequired
  max 10 items
  Show 3 child attributesHide child attributes
  fieldenumrequired
  One ofcountrycontinenttier1deviceosbrowserlanguagereferrerHostsub1sub2sub3sub4sub5hourweekdayisRepeatqualityScore
  openumrequired
  One ofinnotIneqneqgtltcontainsregex
  valuesarray of stringsrequired
  max 250 items
- idstringrequired
  Client-generated short id, stable across edits
  1–32 chars
- enabledboolean
  Whether the item is active.
  Default true
- namestringnullable
  Display name, shown in the dashboard and reports.
  max 80 chars
skipUrlCheckbooleannullable
slugstringnullable
Omit to auto-generate
3–64 chars
tagsarray of stringsnullable
Free-form labels for filtering.
max 20 items
trafficSourcestringnullable
max 80 chars
uniqueScopeenumnullable
One oflinkgroupworkspace

Response · 20129

backupUrlstring · urlrequired
Where capped or rule-excluded visitors go
blankReferrerbooleanrequired
Strip the referrer so the destination cannot see the source
blockedUrlstring · urlrequired
Where blocked (filtered) visitors go; null = 404
campaignstringrequired
max 120 chars
capsobjectrequired
Show 4 child attributesHide child attributes
- maxRawintegernullable
  1–9007199254740990
- maxRawDailyintegernullable
  1–9007199254740990
- maxUniqueintegernullable
  1–9007199254740990
- maxUniqueDailyintegernullable
  1–9007199254740990
cloakobjectrequired
Show 4 child attributesHide child attributes
- descriptionstringnullable
  max 300 chars
- enabledboolean
  Whether the item is active.
  Default false
- imageUrlstring · urlnullable
  Absolute http(s) URL
- titlestringnullable
  max 120 chars
costnumberrequired
What the traffic costs, interpreted by costType
min 0
costTypeenumrequired
One oftotalcpccpcRawcpacpsdailymonthly
createdAtstring · date-timerequired
ISO-8601 timestamp with offset
destinationUrlstring · urlrequired
Absolute http(s) URL
disablePixelsbooleanrequired
domainIdstring · uuidrequired
Custom tracking domain; null = default domain
filtersobjectrequired
Show 8 child attributesHide child attributes
- blockedIpenum
  Matches the workspace IP block list
  One ofoffflagblockDefault "block"
- datacenterenum
  Hosting / cloud ASN — servers, not people
  One ofoffflagblockDefault "flag"
- noCookieenum
  Advanced: visitor refused the cookie
  One ofoffflagblockDefault "off"
- noJsenum
  Advanced: visitor never ran the beacon
  One ofoffflagblockDefault "off"
- proxyenum
  Known anonymous proxy / VPN exit
  One ofoffflagblockDefault "flag"
- serverenum
  Scripted clients: curl, python-requests…
  One ofoffflagblockDefault "flag"
- spiderenum
  Search-engine and social crawlers
  One ofoffflagblockDefault "block"
- velocityenum
  30+ clicks from one visitor within a minute
  One ofoffflagblockDefault "flag"
funnelEntrybooleanrequired
This link is the front of a funnel; children roll up into it
groupIdstring · uuidrequired
Group to file this under; null for none.
idstring · uuidrequired
UUID primary key
namestringrequired
Display name, shown in the dashboard and reports.
1–120 chars
notesstringrequired
max 2000 chars
pixelIdsarray of strings · uuidrequired
Retargeting pixels fired on the interstitial.
max 20 items
redirectTypeenumrequired
HTTP status used for the redirect.
One of301302307
rulesarray of objectsrequired
max 50 items
Show 5 child attributesHide child attributes
- actionobjectrequired
  What to do.
  Show 2 child attributesHide child attributes
  typeenumrequired
  One ofredirectblockpass
  urlstring · urlnullable
  Required when type = redirect
- conditionsarray of objectsrequired
  max 10 items
  Show 3 child attributesHide child attributes
  fieldenumrequired
  One ofcountrycontinenttier1deviceosbrowserlanguagereferrerHostsub1sub2sub3sub4sub5hourweekdayisRepeatqualityScore
  openumrequired
  One ofinnotIneqneqgtltcontainsregex
  valuesarray of stringsrequired
  max 250 items
- idstringrequired
  Client-generated short id, stable across edits
  1–32 chars
- enabledboolean
  Whether the item is active.
  Default true
- namestringnullable
  Display name, shown in the dashboard and reports.
  max 80 chars
skipUrlCheckbooleanrequired
Do not probe the destination for liveness
slugstringrequired
URL-safe slug
3–64 chars
statusenumrequired
Lifecycle state.
One ofactivepausedarchived
tagsarray of stringsrequired
Free-form labels for filtering.
max 20 items
trafficSourcestringrequired
e.g. facebook, google-ads, newsletter
max 80 chars
uniqueScopeenumrequired
One oflinkgroupworkspace
updatedAtstring · date-timerequired
ISO-8601 timestamp with offset
workspaceIdstring · uuidrequired
UUID primary key

Request

curl -X POST "https://api.clicklookup.com/v1/links" \
  -H "Authorization: Bearer $CLICKLOOKUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer sale",
    "destinationUrl": "https://example.com/offer",
    "slug": "summer-sale",
    "tags": [
      "facebook",
      "q3"
    ]
  }'

Response

{
  "backupUrl": "https://example.com/offer",
  "blankReferrer": false,
  "blockedUrl": "https://example.com/offer",
  "campaign": "q3-launch",
  "caps": {
    "maxRaw": 1,
    "maxRawDaily": 1,
    "maxUnique": 1280,
    "maxUniqueDaily": 1280
  },
  "cloak": {
    "description": "Up to 50% off this week",
    "enabled": false,
    "imageUrl": "https://example.com/offer",
    "title": "Summer sale"
  },
  "cost": 1.5,
  "costType": "total",
  "createdAt": "2026-09-22T10:15:00Z",
  "destinationUrl": "https://example.com/offer",
  "disablePixels": false,
  "domainId": "c2e84b19-6f3a-4d7c-8a5e-1b9f2d6e4a73",
  "filters": {
    "blockedIp": "block",
    "datacenter": "flag",
    "noCookie": "off",
    "noJs": "off",
    "proxy": "flag",
    "server": "flag",
    "spider": "block",
    "velocity": "flag"
  },
  "funnelEntry": false,
  "groupId": "9a1d7e42-3c5b-4f8e-b2a6-0d4e8f1c7b35",
  "id": "c2e84b19-6f3a-4d7c-8a5e-1b9f2d6e4a73",
  "name": "Summer sale",
  "notes": "Launched with the Q3 newsletter",
  "pixelIds": [
    "c2e84b19-6f3a-4d7c-8a5e-1b9f2d6e4a73"
  ],
  "redirectType": "301",
  "rules": [
    {
      "action": {
        "type": "redirect",
        "url": "https://example.com/offer"
      },
      "conditions": [
        {
          "field": "country",
          "op": "in",
          "values": [
            {}
          ]
        }
      ],
      "enabled": true,
      "id": "rule-1",
      "name": "Summer sale"
    }
  ],
  "skipUrlCheck": false,
  "slug": "summer-sale",
  "status": "active",
  "tags": [
    "string"
  ],
  "trafficSource": "facebook",
  "uniqueScope": "link",
  "updatedAt": "2026-09-22T10:15:00Z",
  "workspaceId": "c2e84b19-6f3a-4d7c-8a5e-1b9f2d6e4a73"
}