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

# Share links: Preview a new share

> **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 [Share links](/docs/api/shares.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Preview a new share

`POST /v1/shares/preview` - operationId `shares.preview-draft`

| Permission | Rate limit |
| --- | --- |
| Share edit and the `share` permission | 4,800 requests a minute per API key |

Shows what a reviewer would see for a share you have not created yet. Send the same body as
`POST /v1/shares`. Kenso builds the items the way create does, with copy rendered for sample contacts,
but saves nothing and emails no one.

Items in the preview are numbered from 1 and show as not reviewed. The exception is copy and lead lists on an
approve share whose current version is already approved.

Errors:

- `400 validation_failed`: the body fails a check that `POST /v1/shares` makes.
- `404 not_found`: the campaign does not exist in this workspace.

Requires Share edit and the `share` permission.

Needs the `share` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/shares/POST/v1/shares/preview)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `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 | Name of the share, at most 255 characters. Omitted, Kenso names it after the campaign and the shared items, such as "Q4 RevOps · lead list and copy". |
| `company` | string | no | Who the share is for, shown on the share page, at most 255 characters. Omitted, it is the workspace name. |
| `campaignId` | integer (int64) | no | Id of the campaign to share. Required unless `items` holds only `plan`. |
| `accountIds` | array of integer (int64) | no | Ids of the accounts whose plans to share, from 1 to 100. Required with `plan` and ignored without it. |
| `items` | array of string | no | What to share, at least one of: `leads` (the lead lists), `copy` (the email copy), `settings` (the campaign settings), `icp` (the targeting), `report` (the weekly report) and `plan` (account plans). |
| `permission` | string | yes | What reviewers can do: `view`, `comment` or `approve`. Required. |
| `expiry` | string | no | How long the link works, counted from creation: `7_days`, `30_days` or `never`. Omitted means `30_days`. |
| `recipients` | array of string | no | Up to 20 email addresses or names, each at most 254 characters. Kenso emails the link to the email addresses and only records the names. |
| `holdLaunch` | boolean | no | True keeps the campaign from launching or resuming until reviewers approve every item. Needs `approve` and a `leads`, `copy` or `settings` item. Defaults to false. |
| `recurringReport` | boolean | no | True emails the recipients a fresh weekly report every Monday at 8 AM. Needs a `report` item. Defaults to false. |

### Response 200

`data` is a `SharePublic`.

| Field | Type | Description |
| --- | --- | --- |
| `brand` | SharePublicBrand | The branding on the share page. |
| `workspaceName` | string | Name of the workspace that shared the link. |
| `workspaceLogoUrl` | string | URL of the workspace's wide logo, else its square icon. Omitted when it has neither. |
| `workspaceIconUrl` | string | URL of the workspace's square icon, else its wide logo. Omitted when it has neither. |
| `shareName` | string | Name of the share. |
| `company` | string | Who the share is for. |
| `senderName` | string | Name of the member who created the share. Omitted when unknown. |
| `campaignName` | string | Name of the shared campaign. Null when the share has no campaign. |
| `permission` | string | What reviewers can do: `view`, `comment` or `approve`. |
| `expiresAt` | string (date-time) | When the link expires, in UTC. Null when it never expires. |
| `holdLaunch` | boolean | True when the campaign cannot launch or resume until reviewers approve every item. |
| `isSubmitted` | boolean | True once a reviewer sent the review. |
| `submittedAt` | string (date-time) | When a reviewer sent the review, in UTC. Null until then. |
| `submittedByName` | string | Name the reviewer gave when they sent the review. |
| `status` | string | Where the review stands: `not_opened`, `viewed`, `n_of_m_approved`, `changes_requested` or `approved`. |
| `approvedCount` | integer (int32) | Number of kinds approved. Always 0 on view and comment shares. |
| `kindCount` | integer (int32) | Number of kinds on the share. |
| `items` | array of SharePublicItem | The shared items in page order, each with its content and comments. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/shares/preview" \
  -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",
  "company": "string",
  "campaignId": 812,
  "accountIds": [
    812
  ],
  "items": [
    "string"
  ],
  "permission": "view",
  "expiry": "7_days",
  "recipients": [
    "string"
  ],
  "holdLaunch": true,
  "recurringReport": true
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "brand": {
      "productName": "string",
      "logoUrl": "https://example.com",
      "faviconUrl": "https://example.com",
      "accentColor": "string"
    },
    "workspaceName": "string",
    "workspaceLogoUrl": "https://example.com",
    "workspaceIconUrl": "https://example.com",
    "shareName": "string",
    "company": "string",
    "senderName": "string",
    "campaignName": "string",
    "permission": "view",
    "expiresAt": "2026-09-23T15:02:11Z",
    "holdLaunch": true,
    "isSubmitted": true,
    "submittedAt": "2026-09-23T15:02:11Z",
    "submittedByName": "string",
    "status": "not_opened",
    "approvedCount": 1,
    "kindCount": 1,
    "items": [
      {
        "id": 812,
        "kind": "leads",
        "title": "string",
        "status": "string",
        "canUndo": true,
        "decidedAt": "2026-09-23T15:02:11Z",
        "decidedByName": "string",
        "decisionComment": "string",
        "snapshot": null,
        "comments": [
          {
            "id": 812,
            "shareItemId": 812,
            "anchor": "string",
            "body": "string",
            "authorName": "string",
            "createdAt": "2026-09-23T15:02:11Z"
          }
        ]
      }
    ]
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### SharePublicBrand

The branding on a share page, from the workspace's white-label settings.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `productName` | string | no | Product name shown on the page. |
| `logoUrl` | string | no | URL of the logo shown on the page. |
| `faviconUrl` | string | no | URL of the page's favicon. |
| `accentColor` | string | no | The agency's accent color as `#RRGGBB`; null when the workspace is not white-labeled or set none, and while `onboarding_v5` is off for it. |

### SharePublicItem

One shared item as a reviewer sees it.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer (int64) | no | Id of the item on this share. |
| `kind` | string | no | The kind: `leads`, `copy`, `settings`, `icp`, `report` or `plan`. |
| `title` | string | no | Title reviewers see for the item. |
| `status` | string | no | Review status: `approved`, `changes_requested`, `not_reviewed`, `view_only` (a view or comment share, with nothing to decide) or `changed` (the shared content changed after the share was made). |
| `canUndo` | boolean | no | True when the reviewer can undo this item's decision: they made it from this link, the review is not sent yet, there is no newer version, and it is not an approved copy, lead list or settings item of a campaign that is already running. |
| `decidedAt` | string (date-time) | no | When the item was approved or sent back for changes, in UTC. Null while undecided. |
| `decidedByName` | string | no | Name of the person who decided. |
| `decisionComment` | string | no | Comment left with the decision. Null when there is none. |
| `snapshot` | object | no | The item's content as a JSON object with camelCase keys, frozen when the item was created. Its shape depends on `kind`: the campaign settings, the ICP, the weekly report, an account plan, the copy or a lead list. |
| `comments` | array of ShareComment | no | Comments on the item. |

### ShareComment

A comment on a shared item.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer (int64) | no | Id of the comment. |
| `shareItemId` | integer (int64) | no | Id of the share item the comment is on. |
| `anchor` | string | no | The step, variant or paragraph the comment points at. Null when it is about the whole item. |
| `body` | string | no | Text of the comment. |
| `authorName` | string | no | Name the author gave. |
| `createdAt` | string (date-time) | no | When the comment was left, in UTC. |
