> 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: Create a 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).

## Create a share

`POST /v1/shares` - operationId `shares.create`

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

Creates a share link, freezes a snapshot of each shared item, and emails the link to every recipient that is
an email address. Returns `201` with the new share and its `url`.

Send `items` and `permission`. `campaignId` is required unless the share holds only account
plans, and `accountIds` is required with `plan`. The request body fields list every option and its
rules.

Copy is one item, lead lists are one item per active segment, and plans are one item per account. On an
approve share, the copy and lead list items are the same approval items the campaign's launch waits on, so a
decision on the link also counts for launch. Kenso does not email a recipient that already got a share email
from this workspace in the last 24 hours, and lists them in `alreadyEmailedRecipients`. Each address
Kenso emails counts against the workspace's daily share email cap.

Errors:

- `400 validation_failed`: a field is missing or invalid. A campaign with no copy or no active segment
gives an `items` detail with code `empty`, and an account that is not in this workspace gives an
`accountIds[n]` detail with code `not_found`.
- `403 forbidden`: the caller is a workspace key. The share records the member who shared it, and a
workspace key is not a person.
- `404 not_found`: the campaign does not exist in this workspace.
- `429 quota_exceeded`: the emails would pass the workspace's daily share email cap (detail code
`share_email_quota`). Kenso creates nothing and emails no one.

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)

### 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 201

`data` is a `Share`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | Id of the share. |
| `name` | string | Name of the share. Reviewers see it on the share page. |
| `company` | string | Who the share is for, shown on the share page. Defaults to the workspace name. |
| `url` | string | The link to send, in the form `https://<app host>/s/<token>`. Anyone with the link can act on the share. Empty unless you have Share edit and the `share` permission. |
| `campaignId` | integer (int64) | Id of the shared campaign. Null when the share holds only account plans. |
| `campaignName` | string | Name of the shared campaign. Null when the share has no campaign. |
| `accountIds` | array of integer (int64) | Ids of the accounts whose plans are shared, in the order picked. Omitted when the share has no plans. |
| `kinds` | array of string | What the share holds, in page order: `leads`, `copy`, `settings`, `icp`, `report` and `plan`. |
| `permission` | string | What reviewers can do: `view`, `comment` or `approve`. |
| `expiry` | string | How long the link works, counted from creation: `7_days`, `30_days` or `never`. |
| `expiresAt` | string (date-time) | When the link expires, in UTC. Null when it never expires. |
| `isExpired` | boolean | True once `expiresAt` has passed and the link no longer works. |
| `holdLaunch` | boolean | True when the campaign cannot launch or resume until reviewers approve every item. |
| `recurringReport` | boolean | True when Kenso emails the recipients a fresh weekly report every Monday at 8 AM. |
| `recipients` | array of string | The email addresses and names the share is for. Kenso emails only the email addresses. |
| `unsubscribedRecipients` | array of string | The email addresses in `recipients` that unsubscribed from this workspace's share emails, as written in `recipients`. Kenso sends them no share email: no link, reminder or weekly report. |
| `status` | string | Where the review stands: `not_opened`, `viewed`, `n_of_m_approved` (some kinds approved, none with changes requested), `changes_requested` or `approved`. View and comment shares only show `not_opened` or `viewed`. |
| `approvedCount` | integer (int32) | Number of kinds approved, as in "2 of 3 approved". Always 0 on view and comment shares. |
| `kindCount` | integer (int32) | Number of kinds on the share. |
| `changesRequestedCount` | integer (int32) | Number of kinds with changes requested. |
| `kindStatuses` | array of ShareKindStatus | One review status per kind on the share, in page order. |
| `viewCount` | integer (int32) | Number of times the link was opened. Previews through `GET /v1/shares/{shareId}/preview` do not count. |
| `firstViewedAt` | string (date-time) | When a reviewer first opened the link, in UTC. Null until then. |
| `lastViewedAt` | string (date-time) | When a reviewer last opened the link, in UTC. Null until then. |
| `submittedAt` | string (date-time) | When a reviewer sent the review, in UTC. Null until then. After that, the decisions cannot be undone. |
| `submittedByName` | string | Name the reviewer gave when they sent the review. |
| `lastReportSentAt` | string (date-time) | When the share last got a fresh weekly report, in UTC. Null when the share has no report. |
| `createdByUserId` | integer (int64) | Id of the member who created the share. Null when unknown. |
| `createdAt` | string (date-time) | When the share was created, in UTC. |
| `lastActivityAt` | string (date-time) | When anything last happened on the share, in UTC: created, viewed, a decision, a comment, a reminder, a report sent or the review sent. |
| `items` | array of ShareItem | The shared items with their review status. Returned by get, create and update, and omitted from the list. |
| `comments` | array of ShareComment | The comments left through this share, oldest first. Returned by get, create and update, and omitted from the list. |
| `access` | array of ShareAccessRow | What reviewers may do, as label and value rows: "They can", "Expires", "Launch", "Repeats" and "Branding". Returned by get, create and update, and omitted from the list. |
| `activity` | array of ShareActivity | The share's log, newest first, at most 50 entries. Returned by get, create and update, and omitted from the list. |
| `alreadyEmailedRecipients` | array of string | On create only: the recipients Kenso did not email, because a share email from this workspace reached them in the last 24 hours. Send them the link yourself. Omitted when Kenso emailed everyone. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/shares" \
  -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": {
    "id": 812,
    "name": "string",
    "company": "string",
    "url": "https://example.com",
    "campaignId": 812,
    "campaignName": "string",
    "accountIds": [
      812
    ],
    "kinds": [
      "string"
    ],
    "permission": "view",
    "expiry": "7_days",
    "expiresAt": "2026-09-23T15:02:11Z",
    "isExpired": true,
    "holdLaunch": true,
    "recurringReport": true,
    "recipients": [
      "string"
    ],
    "unsubscribedRecipients": [
      "string"
    ],
    "status": "string",
    "approvedCount": 1,
    "kindCount": 1,
    "changesRequestedCount": 1,
    "kindStatuses": [
      {
        "kind": "leads",
        "status": "string"
      }
    ],
    "viewCount": 1,
    "firstViewedAt": "2026-09-23T15:02:11Z",
    "lastViewedAt": "2026-09-23T15:02:11Z",
    "submittedAt": "2026-09-23T15:02:11Z",
    "submittedByName": "string",
    "lastReportSentAt": "2026-09-23T15:02:11Z",
    "createdByUserId": 812,
    "createdAt": "2026-09-23T15:02:11Z",
    "lastActivityAt": "2026-09-23T15:02:11Z",
    "items": [
      {
        "id": 812,
        "kind": "leads",
        "title": "string",
        "status": "string",
        "approvalItemId": 812,
        "decidedAt": "2026-09-23T15:02:11Z",
        "decidedByName": "string",
        "decisionComment": "string",
        "commentCount": 1
      }
    ],
    "comments": [
      {
        "id": 812,
        "shareItemId": 812,
        "anchor": "string",
        "body": "string",
        "authorName": "string",
        "createdAt": "2026-09-23T15:02:11Z"
      }
    ],
    "access": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "activity": [
      {
        "id": 812,
        "type": "share_created",
        "shareItemId": 812,
        "actorKind": "string",
        "actorName": "string",
        "actorUserId": 812,
        "data": null,
        "createdAt": "2026-09-23T15:02:11Z"
      }
    ],
    "alreadyEmailedRecipients": [
      "string"
    ]
  }
}
```

## Types

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

### ShareKindStatus

The review status of one kind on a share.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | string | no | The kind: `leads`, `copy`, `settings`, `icp`, `report` or `plan`. |
| `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). |

### ShareItem

One item on a share. Lead lists give one item per segment, and plans one item per account.

| 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). |
| `approvalItemId` | integer (int64) | no | Id of the approval item behind this share item. Read it with `GET /v1/client-approvals/items/{itemId}`. |
| `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. |
| `commentCount` | integer (int32) | no | Number of 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. |

### ShareAccessRow

One row of a share's access summary.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `label` | string | no | Row label, such as "They can" or "Expires". |
| `value` | string | no | Row text, such as "View and comment" or "30 days after sharing". |

### ShareActivity

One entry in a share's log.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer (int64) | no | Id of the entry. |
| `type` | string | no | What happened, such as `share_created`, `share_viewed`, `approved`, `changes_requested`, `commented`, `decision_undone`, `share_submitted`, `share_reminder_sent` or `report_sent`. Other types can appear, so handle unknown values. |
| `shareItemId` | integer (int64) | no | Id of the share item the entry is about. Omitted for an entry about the whole share. |
| `actorKind` | string | no | Who acted: `user` (a workspace member), `reviewer` (someone using the link) or `system` (Kenso). |
| `actorName` | string | no | Name of the person who acted, when known. |
| `actorUserId` | integer (int64) | no | Id of the member who acted. Null unless `actorKind` is `user`. |
| `data` | object | no | Details of the entry as a JSON object. Its keys depend on `type`. Null when there are none. |
| `createdAt` | string (date-time) | no | When it happened, in UTC. |
