> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/tracking-links/openapi.json](/docs/api/tracking-links/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Tracking links

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

The tracked links of a campaign's emails.

Deliverability. 5 endpoints under `https://api.ken.so`. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`: see [Authentication](/docs/authentication.md), [Workspaces](/docs/workspaces.md) and [Errors](/docs/errors.md). OpenAPI for this resource only: [/docs/api/tracking-links/openapi.json](/docs/api/tracking-links/openapi.json).

- `GET /v1/campaigns/{campaignId}/tracking-links` - List a campaign's tracking links (`tracking-links.list`): [/docs/api/tracking-links/list.md](/docs/api/tracking-links/list.md)
- `POST /v1/campaigns/{campaignId}/tracking-links` - Create a tracking link (`tracking-links.create`): [/docs/api/tracking-links/create.md](/docs/api/tracking-links/create.md)
- `GET /v1/tracking-links/{trackingLinkId}` - Get a tracking link (`tracking-links.get`): [/docs/api/tracking-links/get.md](/docs/api/tracking-links/get.md)
- `PATCH /v1/tracking-links/{trackingLinkId}` - Update a tracking link (`tracking-links.update`): [/docs/api/tracking-links/update.md](/docs/api/tracking-links/update.md)
- `DELETE /v1/tracking-links/{trackingLinkId}` - Delete a tracking link (`tracking-links.delete`): [/docs/api/tracking-links/delete.md](/docs/api/tracking-links/delete.md)

## List a campaign's tracking links

`GET /v1/campaigns/{campaignId}/tracking-links` - operationId `tracking-links.list`

| Permission | Rate limit |
| --- | --- |
| Delivery view | 12,000 requests a minute per API key |

Lists the tracking links of one campaign, oldest first. Use it to find a link's id for the
`{{tracking_link:ID}}` token in the sequence copy.

Errors:

- `400 validation_failed`: `limit` is not from 1 to 200, or `cursor` is invalid.
- `401 unauthenticated`: the credential does not identify a member.
- `404 not_found`: the workspace has no campaign with this id.

Requires Delivery view.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/tracking-links/GET/v1/campaigns/%7BcampaignId%7D/tracking-links)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `campaignId` | path | integer (int64) | yes | Id of the campaign. |
| `limit` | query | integer (int32) | no | Links per page, from 1 to 200. Defaults to 50. |
| `cursor` | query | string | no | The `nextCursor` from the previous page. Omit it for the first page. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a list of `TrackingLink`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | Id of the tracking link. Use it in the sequence copy as `{{tracking_link:ID}}`. |
| `campaignId` | integer (int64) | Id of the campaign the link belongs to. |
| `name` | string | Label that names the link in Kenso. Recipients never see it. |
| `domainName` | string | Destination URL the link redirects to, such as `https://acme.com/demo`. It holds a full URL, not only a domain. |
| `textValue` | string | Text the link shows in an email. Empty or omitted means emails show the destination address instead. |
| `createdAt` | string (date-time) | When the link was created, in UTC. |
| `createdBy` | integer (int64) | User id of the member who created the link. |
| `modifiedAt` | string (date-time) | When the link last changed, in UTC. |
| `modifiedBy` | integer (int64) | User id of the member who last changed the link. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/campaigns/812/tracking-links?limit=50" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": [
    {
      "id": 812,
      "campaignId": 812,
      "name": "string",
      "domainName": "https://acme.com/demo",
      "textValue": "string",
      "createdAt": "2026-09-23T15:02:11Z",
      "createdBy": 1,
      "modifiedAt": "2026-09-23T15:02:11Z",
      "modifiedBy": 1
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Create a tracking link

`POST /v1/campaigns/{campaignId}/tracking-links` - operationId `tracking-links.create`

| Permission | Rate limit |
| --- | --- |
| Delivery edit | 4,800 requests a minute per API key |

Adds a tracking link to a campaign. Put the returned id in the sequence copy as `{{tracking_link:ID}}`.

Send `name` and `domainName`, the destination URL. `textValue` is optional: without it the link
shows the destination without `https://` and `www.`. Kenso refuses a destination whose host is on a
malware blocklist or whose domain was registered less than 30 days ago. The age rule skips the workspace's own
domains. Returns `201` with the link, and the `Location` header holds the link's path.

Errors:

- `400 validation_failed`: `name` is missing or over 1,024 characters, `domainName` is not an http or https URL on a public host or is over 500 characters, `textValue` is over 500 characters or has control characters, or the destination failed the check above.
- `401 unauthenticated`: the credential does not identify a member.
- `404 not_found`: the workspace has no campaign with this id.

Requires Delivery edit.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/tracking-links/POST/v1/campaigns/%7BcampaignId%7D/tracking-links)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `campaignId` | path | integer (int64) | yes | Id of the campaign. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | Label that names the link in Kenso, at most 1,024 characters. Recipients never see it. Required. |
| `domainName` | string | yes | Destination URL the link redirects to: an absolute http or https URL on a public host, at most 500 characters, such as `https://acme.com/demo`. Required. |
| `textValue` | string | no | Text the link shows in an email, at most 500 characters and without control characters. Omitted shows the destination without `https://` and `www.`. |

### Response 201

`data` is a `TrackingLink`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | Id of the tracking link. Use it in the sequence copy as `{{tracking_link:ID}}`. |
| `campaignId` | integer (int64) | Id of the campaign the link belongs to. |
| `name` | string | Label that names the link in Kenso. Recipients never see it. |
| `domainName` | string | Destination URL the link redirects to, such as `https://acme.com/demo`. It holds a full URL, not only a domain. |
| `textValue` | string | Text the link shows in an email. Empty or omitted means emails show the destination address instead. |
| `createdAt` | string (date-time) | When the link was created, in UTC. |
| `createdBy` | integer (int64) | User id of the member who created the link. |
| `modifiedAt` | string (date-time) | When the link last changed, in UTC. |
| `modifiedBy` | integer (int64) | User id of the member who last changed the link. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/campaigns/812/tracking-links" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "domainName": "https://acme.com/demo",
  "textValue": "string"
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "id": 812,
    "campaignId": 812,
    "name": "string",
    "domainName": "https://acme.com/demo",
    "textValue": "string",
    "createdAt": "2026-09-23T15:02:11Z",
    "createdBy": 1,
    "modifiedAt": "2026-09-23T15:02:11Z",
    "modifiedBy": 1
  }
}
```

## Get a tracking link

`GET /v1/tracking-links/{trackingLinkId}` - operationId `tracking-links.get`

| Permission | Rate limit |
| --- | --- |
| Delivery view | 12,000 requests a minute per API key |

Returns one tracking link with its destination and link text.

Errors:

- `401 unauthenticated`: the credential does not identify a member.
- `404 not_found`: the workspace has no tracking link with this id.

Requires Delivery view.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/tracking-links/GET/v1/tracking-links/%7BtrackingLinkId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `trackingLinkId` | path | integer (int64) | yes | Id of the tracking link. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `TrackingLink`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | Id of the tracking link. Use it in the sequence copy as `{{tracking_link:ID}}`. |
| `campaignId` | integer (int64) | Id of the campaign the link belongs to. |
| `name` | string | Label that names the link in Kenso. Recipients never see it. |
| `domainName` | string | Destination URL the link redirects to, such as `https://acme.com/demo`. It holds a full URL, not only a domain. |
| `textValue` | string | Text the link shows in an email. Empty or omitted means emails show the destination address instead. |
| `createdAt` | string (date-time) | When the link was created, in UTC. |
| `createdBy` | integer (int64) | User id of the member who created the link. |
| `modifiedAt` | string (date-time) | When the link last changed, in UTC. |
| `modifiedBy` | integer (int64) | User id of the member who last changed the link. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/tracking-links/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "id": 812,
    "campaignId": 812,
    "name": "string",
    "domainName": "https://acme.com/demo",
    "textValue": "string",
    "createdAt": "2026-09-23T15:02:11Z",
    "createdBy": 1,
    "modifiedAt": "2026-09-23T15:02:11Z",
    "modifiedBy": 1
  }
}
```

## Update a tracking link

`PATCH /v1/tracking-links/{trackingLinkId}` - operationId `tracking-links.update`

| Permission | Rate limit |
| --- | --- |
| Delivery edit | 4,800 requests a minute per API key |

Changes a tracking link's name, destination or link text. A field you leave out keeps its value, and
`null` on `textValue` clears the text so emails show the destination address instead.

A new `domainName` goes through the same destination check as on create. Kenso also points the tracking
URLs already generated for the link at the new destination, so emails already sent redirect there too. Once
emails with the link went out, a workspace can change destinations 20 times a day. Returns the updated link.

Errors:

- `400 validation_failed`: a field breaks one of the rules listed on create, or the new destination failed the check.
- `401 unauthenticated`: the credential does not identify a member.
- `402 plan_limit_reached`: the workspace is not on a paid plan, so it cannot change a destination (`refusal.code` is `link_edit_requires_paid_plan`). Create a new link instead.
- `403 forbidden`: you cannot access the link's campaign.
- `404 not_found`: the workspace has no tracking link with this id.
- `409 shared_host_link_frozen`: the link has tracking URLs on a host Kenso shares between workspaces, so its destination cannot change. Create a new link instead.
- `409 conflict`: Kenso is generating the campaign's tracking URLs. Try again when it finishes.
- `429 rate_limited`: the workspace reached its daily limit of destination changes. `Retry-After` says when to try again.

Requires Delivery edit.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/tracking-links/PATCH/v1/tracking-links/%7BtrackingLinkId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `trackingLinkId` | path | integer (int64) | yes | Id of the tracking link. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no | New label for the link, at most 1,024 characters. Omitted keeps the current name. |
| `domainName` | string | no | New destination URL: an absolute http or https URL on a public host, at most 500 characters. Omitted keeps the current destination. |
| `textValue` | string | no | New link text, at most 500 characters and without control characters. Null clears it, so emails show the destination address. Omitted keeps the current text. |

### Response 200

`data` is a `TrackingLink`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | Id of the tracking link. Use it in the sequence copy as `{{tracking_link:ID}}`. |
| `campaignId` | integer (int64) | Id of the campaign the link belongs to. |
| `name` | string | Label that names the link in Kenso. Recipients never see it. |
| `domainName` | string | Destination URL the link redirects to, such as `https://acme.com/demo`. It holds a full URL, not only a domain. |
| `textValue` | string | Text the link shows in an email. Empty or omitted means emails show the destination address instead. |
| `createdAt` | string (date-time) | When the link was created, in UTC. |
| `createdBy` | integer (int64) | User id of the member who created the link. |
| `modifiedAt` | string (date-time) | When the link last changed, in UTC. |
| `modifiedBy` | integer (int64) | User id of the member who last changed the link. |

### Request

```bash
curl -X PATCH "https://api.ken.so/v1/tracking-links/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "domainName": "string",
  "textValue": "string"
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "id": 812,
    "campaignId": 812,
    "name": "string",
    "domainName": "https://acme.com/demo",
    "textValue": "string",
    "createdAt": "2026-09-23T15:02:11Z",
    "createdBy": 1,
    "modifiedAt": "2026-09-23T15:02:11Z",
    "modifiedBy": 1
  }
}
```

## Delete a tracking link

`DELETE /v1/tracking-links/{trackingLinkId}` - operationId `tracking-links.delete`

| Permission | Rate limit |
| --- | --- |
| Delivery edit | 4,800 requests a minute per API key |

Deletes a tracking link and deactivates every tracking URL Kenso generated from it, including those in emails
already sent. Returns `204` with no body.

Errors:

- `401 unauthenticated`: the credential does not identify a member.
- `403 forbidden`: you cannot access the link's campaign.
- `404 not_found`: the workspace has no tracking link with this id.
- `409 conflict`: Kenso is generating the campaign's tracking URLs. Try again when it finishes.

Requires Delivery edit.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/tracking-links/DELETE/v1/tracking-links/%7BtrackingLinkId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `trackingLinkId` | path | integer (int64) | yes | Id of the tracking link. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 204

### Request

```bash
curl -X DELETE "https://api.ken.so/v1/tracking-links/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```http
HTTP/1.1 204 No Content
```

All resources: [/docs.md](/docs.md).
