Create Click - Documentation

curl -X POST 'https://api.tolt.com/v1/clicks' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
    "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
    "country": "US",
    "device": "desktop",
    "page": "https://example.com/product",
    "referrer": "https://google.com"
}'

curl -X POST 'https://api.tolt.com/v1/clicks' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "param": "ref",
    "value": "michael_scott",
    "country": "US",
    "device": "mobile",
    "page": "https://example.com/product",
    "referrer": "https://twitter.com"
}'

{
  "success": true,
  "data": [
    {
      "id": "clk_dK9bzRGn46BhVgNFHD6fDgXW",
      "page": "https://example.com/product",
      "referrer": "https://google.com",
      "device": "desktop",
      "browser": null,
      "country": "US",
      "state": null,
      "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "created_at": "2025-04-25T11:22:35.546Z",
      "updated_at": "2025-04-25T11:22:35.546Z"
    }
  ]
}

{
  "success": true,
  "data": [
    {
      "id": "clk_dK9bzRGn46BhVgNFHD6fDgXW",
      "page": "https://example.com/product",
      "referrer": "https://google.com",
      "device": "desktop",
      "browser": null,
      "country": "US",
      "state": null,
      "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "created_at": "2025-04-25T11:22:35.546Z",
      "updated_at": "2025-04-25T11:22:35.546Z"
    }
  ]
}

POST

clicks

curl -X POST 'https://api.tolt.com/v1/clicks' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
    "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
    "country": "US",
    "device": "desktop",
    "page": "https://example.com/product",
    "referrer": "https://google.com"
}'

curl -X POST 'https://api.tolt.com/v1/clicks' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "param": "ref",
    "value": "michael_scott",
    "country": "US",
    "device": "mobile",
    "page": "https://example.com/product",
    "referrer": "https://twitter.com"
}'

{
  "success": true,
  "data": [
    {
      "id": "clk_dK9bzRGn46BhVgNFHD6fDgXW",
      "page": "https://example.com/product",
      "referrer": "https://google.com",
      "device": "desktop",
      "browser": null,
      "country": "US",
      "state": null,
      "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "created_at": "2025-04-25T11:22:35.546Z",
      "updated_at": "2025-04-25T11:22:35.546Z"
    }
  ]
}

{
  "success": true,
  "data": [
    {
      "id": "clk_dK9bzRGn46BhVgNFHD6fDgXW",
      "page": "https://example.com/product",
      "referrer": "https://google.com",
      "device": "desktop",
      "browser": null,
      "country": "US",
      "state": null,
      "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "created_at": "2025-04-25T11:22:35.546Z",
      "updated_at": "2025-04-25T11:22:35.546Z"
    }
  ]
}

Base URL `https://api.tolt.com`

Body Parameters

You can create a click using one of these two methods:

Method 1: Using Partner and Link IDs

partner_id*

string

The ID of the partner who generated the click

link_id

string - optional

The ID of the link that was clicked

Method 2: Using Tracking Parameter

param*

string

The tracking parameter name (e.g., ‘ref’, ‘via’)

value*

string

The value of the tracking parameter

Common Optional Parameters

country

string - optional

Two-letter ISO country code where the click originated

device

string - optional

Device type that generated the click (e.g., ‘desktop’, ‘mobile’, ‘tablet’)

page

string - optional

URL of the page where the click occurred

referrer

string - optional

URL of the referring page

Response

success

boolean

Whether the request was successful

data

object

Hide properties

string

Unique identifier for the click, uuid or prefixed with clk_

partner_id

string

ID of the partner who generated the click

link_id

string

ID of the link that was clicked

country

string

Two-letter ISO country code

state

string | null

State

device

string

Device type

page

string

Page URL

browser

string | null

Browser name

referrer

string

Referrer URL

created_at

string

ISO 8601 timestamp of creation

program_id

string

Program ID the click belongs to

organization_id

string

Organization ID

curl -X POST 'https://api.tolt.com/v1/clicks' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
    "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
    "country": "US",
    "device": "desktop",
    "page": "https://example.com/product",
    "referrer": "https://google.com"
}'

curl -X POST 'https://api.tolt.com/v1/clicks' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "param": "ref",
    "value": "michael_scott",
    "country": "US",
    "device": "mobile",
    "page": "https://example.com/product",
    "referrer": "https://twitter.com"
}'

{
  "success": true,
  "data": [
    {
      "id": "clk_dK9bzRGn46BhVgNFHD6fDgXW",
      "page": "https://example.com/product",
      "referrer": "https://google.com",
      "device": "desktop",
      "browser": null,
      "country": "US",
      "state": null,
      "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "created_at": "2025-04-25T11:22:35.546Z",
      "updated_at": "2025-04-25T11:22:35.546Z"
    }
  ]
}

{
  "success": true,
  "data": [
    {
      "id": "clk_dK9bzRGn46BhVgNFHD6fDgXW",
      "page": "https://example.com/product",
      "referrer": "https://google.com",
      "device": "desktop",
      "browser": null,
      "country": "US",
      "state": null,
      "link_id": "lnk_dK9bzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "created_at": "2025-04-25T11:22:35.546Z",
      "updated_at": "2025-04-25T11:22:35.546Z"
    }
  ]
}

Delete Customer List Links

​Base URL https://api.tolt.com

​Body Parameters

​Method 1: Using Partner and Link IDs

​Method 2: Using Tracking Parameter

​Common Optional Parameters

​Response

Base URL `https://api.tolt.com`

Body Parameters

Method 1: Using Partner and Link IDs

Method 2: Using Tracking Parameter

Common Optional Parameters

Response