Create a short link (single) or a batch (EDITOR)

Body containing a links array is treated as a batch create; otherwise a single link is created. Also reachable by the internal remote-MCP server as create_short_link (requireProjectRoleOrMcpScope EDITOR / ‘mcp:links_write’).

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Request Body^required

application/json

One of:

object
object

object

destinationUrl

required

Normalized to a valid absolute URL.

string

>= 1 characters

name

string | null

campaignId

required

string

>= 1 characters

adPlatformConfigId

string | null

utmSource

string | null

utmMedium

string | null

utmCampaign

string | null

utmTerm

string | null

utmContent

string | null

platformConfig

object

key

additional properties

any

expiresAt

ISO date/time or null.

string | null

domainId

Null/omitted = platform default domain.

string | null

Example^generated

1
{
2
  "destinationUrl": "example",
3
  "name": "example",
4
  "campaignId": "example",
5
  "adPlatformConfigId": "example",
6
  "utmSource": "example",
7
  "utmMedium": "example",
8
  "utmCampaign": "example",
9
  "utmTerm": "example",
10
  "utmContent": "example",
11
  "platformConfig": {},
12
  "expiresAt": "example",
13
  "domainId": "example"
14
}

Responses

201

{ link } for single, or { links, count } for batch.

application/json

object

key

additional properties

any

400

Invalid config / create failed

application/json

Validation error envelope (Zod). issues/details present on schema failures.

object

error

required

string

issues

Array<object>

object

key

additional properties

any

details

Array<object>

object

key

additional properties

any

Example^generated

1
{
2
  "error": "example",
3
  "issues": [
4
    {}
5
  ],
6
  "details": [
7
    {}
8
  ]
9
}

POST

/api/projects/{projectId}/links

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/links \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '"<string>"'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/links';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '"<string>"'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/links"
4

5
payload = "<string>"
6
headers = {
7
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
8
    "Content-Type": "application/json"
9
}
10

11
response = requests.post(url, json=payload, headers=headers)
12

13
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/links"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("\"<string>\"")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/links"
13

14
  payload := strings.NewReader("\"<string>\"")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201{ link } for single, or { links, count } for batch.

1
{}

Create a short link (single) or a batch (EDITOR)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

201

400

Examplegenerated

Request Body^required

Example^generated

Example^generated