Skip to Content
Deliverability

Tracking links

The tracked links of a campaign's emails.

Deliverability5 endpointsKen-Version: 2026-11-02AuthenticationWorkspacesErrors
MarkdownOpenAPI

Path parameters

The endpoints whose path names one of these take it as described here. An endpoint's own table lists a path parameter only when it describes it differently.

NameInTypeRequiredDescription
campaignIdpathinteger (int64)requiredId of the campaign.
trackingLinkIdpathinteger (int64)requiredId of the tracking link.

Headers

The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.

NameInTypeRequiredDescription
Ken-Versionheaderstring, one of: 2026-11-02, 1.1optionalThe 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 date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.
X-Ken-Workspace-Idheaderinteger (int64)optionalThe 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.

List a campaign's tracking links

GET/v1/campaigns/{campaignId}/tracking-linkstracking-links.list
Permission
Delivery view
Rate limit
12,000 requests a minute per API key

Try it on developer.ken.so

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.

Parameters

NameInTypeRequiredDescription
limitqueryinteger (int32)optionalLinks per page, from 1 to 200. Defaults to 50.
cursorquerystringoptionalThe nextCursor from the previous page. Omit it for the first page.
Request
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"

Response 200

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

Show the 9 response fields and an example

The fields and an example are also on this endpoint's Markdown page.

Create a tracking link

POST/v1/campaigns/{campaignId}/tracking-linkstracking-links.create
Permission
Delivery edit
Rate limit
4,800 requests a minute per API key

Try it on developer.ken.so

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.

Request body

application/json, optional.

FieldTypeRequiredDescription
namestringrequiredLabel that names the link in Kenso, at most 1,024 characters. Recipients never see it. Required.
domainNamestringrequiredDestination 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.
textValuestringoptionalText the link shows in an email, at most 500 characters and without control characters. Omitted shows the destination without https:// and www..
Request
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"
}'

Response 201

data is a TrackingLink.

Show the 9 response fields and an example

The fields and an example are also on this endpoint's Markdown page.

Get a tracking link

GET/v1/tracking-links/{trackingLinkId}tracking-links.get
Permission
Delivery view
Rate limit
12,000 requests a minute per API key

Try it on developer.ken.so

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.

Request
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"

Response 200

data is a TrackingLink.

Show the 9 response fields and an example

The fields and an example are also on this endpoint's Markdown page.

Update a tracking link

PATCH/v1/tracking-links/{trackingLinkId}tracking-links.update
Permission
Delivery edit
Rate limit
4,800 requests a minute per API key

Try it on developer.ken.so

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.

Request body

application/json, optional.

FieldTypeRequiredDescription
namestringoptionalNew label for the link, at most 1,024 characters. Omitted keeps the current name.
domainNamestringoptionalNew destination URL: an absolute http or https URL on a public host, at most 500 characters. Omitted keeps the current destination.
textValuestringoptionalNew link text, at most 500 characters and without control characters. Null clears it, so emails show the destination address. Omitted keeps the current text.
Request
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"
}'

Response 200

data is a TrackingLink.

Show the 9 response fields and an example

The fields and an example are also on this endpoint's Markdown page.

Delete a tracking link

DELETE/v1/tracking-links/{trackingLinkId}tracking-links.delete
Permission
Delivery edit
Rate limit
4,800 requests a minute per API key

Try it on developer.ken.so

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.

Request
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"

Response 204

Response 204
HTTP/1.1 204 No Content

On this page