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

# Segment email sequences: Test a segment's email sequence

> **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.

One endpoint of [Segment email sequences](/docs/api/segment-email-sequences.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Test a segment's email sequence

`POST /v1/segments/{segmentId}/email-sequence/test-send` - operationId `segment-email-sequences.test-send`

| Permission | Rate limit |
| --- | --- |
| Campaigns edit | 200 requests a minute per API key |

Sends the segment's own email sequence to up to 5 addresses, filled with one contact's data, so you can check
the emails in a real inbox.

The address, inbox and daily limit rules of `POST /v1/campaigns/{campaignId}/email-sequence/test-send` apply.
When some emails fail, the call still answers `200`: read `emailsSent` and `failures`.

`providerTrack` (`google`, `microsoft` or `other`) previews or tests the email as that provider track sends it:
recipients on Google get plain text. A track's own `sequenceSegmentId` implies its track. Ignored when the campaign
is not on provider tracks.

Errors:

- `400 validation_failed`: a required field is missing, an address is invalid, blocked or hard bounced, the inbox cannot be used, or no step has a subject or body.
- `400 validation_failed` with detail `invalid_track`: `providerTrack` is not `google`, `microsoft` or `other`.
- `402 free_plan_sending_needs_plan`: the workspace is on the Free plan, which sends nothing (test emails included) for a workspace created after the Free no-send rule started. `error.refusal` has `code` `FREE_PLAN_SENDING_NEEDS_PLAN` and `remedy` `Upgrade`: pick a paid plan, then send again.
- `404 not_found`: the segment does not exist in this workspace or has no email sequence of its own, or the contact is not in the campaign.
- `429 rate_limited`: the workspace has used its test emails for today.

Requires Campaigns edit.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/sequences/POST/v1/segments/%7BsegmentId%7D/email-sequence/test-send)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `segmentId` | path | integer (int64) | yes | The segment's id. |
| `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 |
| --- | --- | --- | --- |
| `contactId` | integer (int64) | yes | The id of the contact whose details fill the variables. Required, and the contact must be in the campaign. |
| `targetEmails` | string | yes | The addresses to send the test to, separated by commas or semicolons, at most 5. Required. Addresses on the workspace's blocklist or with a hard bounce are refused. |
| `senderEmailId` | integer (int64) | yes | The id of the inbox to send from. Required. Once the campaign has inboxes, it must be one of them, and it must be able to send. |
| `language` | string | no | A language or locale tag, such as `fr` or `fr-FR`. Kenso sends the steps as a contact in that language would get them. Omit it to use the contact's own language. The campaign's source language sends the original text. |
| `providerTrack` | string | no | `google`, `microsoft` or `other`. Kenso sends the steps as that provider track sends them: recipients on Google get plain text. On a segment, a track's own `sequenceSegmentId` implies its track. Ignored when the campaign is not on provider tracks. |

### Response 200

`data` is a `EmailSequenceTestSend`.

| Field | Type | Description |
| --- | --- | --- |
| `stepsSent` | integer (int32) | Steps that reached every address in `targetEmails`. Each variant counts as a step. |
| `emailsAttempted` | integer (int32) | Emails Kenso tried to send, at most one per step and address. |
| `emailsSent` | integer (int32) | Emails that went out. |
| `sentTo` | array of string | The addresses that got at least one email, in alphabetical order. |
| `failures` | array of string | One message for each email or step that did not go out. Each message starts with the step number. |
| `notes` | array of string | Notes on emails that went out differently from the step as written, such as a handwritten letter sent as normal text. These emails did go out. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/segments/812/email-sequence/test-send" \
  -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 '{
  "contactId": 90125,
  "targetEmails": "jordan.patel@northwind-outbound.example.com",
  "senderEmailId": 5530,
  "providerTrack": "google"
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "stepsSent": 2,
    "emailsAttempted": 2,
    "emailsSent": 2,
    "sentTo": [
      "jordan.patel@northwind-outbound.example.com"
    ],
    "failures": [],
    "notes": []
  }
}
```
