{"openapi":"3.0.4","info":{"title":"Kenso API: Share links","version":"1.1","description":"The Share links endpoints of the Kenso API, with every component they use. The full spec is https://api.ken.so/v1/docs/openapi.json. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`."},"servers":[{"url":"https://api.ken.so"}],"security":[{"Bearer":[]}],"tags":[{"name":"shares","description":"A share is a named, expiring review link that shows a client parts of a campaign without a Kenso login: lead\nlists, email copy, settings, targeting (ICP), the weekly report or account plans. Each share lets its reviewers\nview, comment on or approve the items. On an approve share, the copy and lead list items are the same approval\nitems the campaign's launch waits on, so a decision on the link also counts for launch. A share's `url`\nholds its secret token, so reads return it only to members who may manage shares.","x-displayName":"Share links"}],"paths":{"/v1/shares":{"get":{"tags":["shares"],"summary":"List shares","description":"Lists the workspace's share links, newest first. Revoked shares are left out.\n            \nFilter with `campaignId`, `accountId` (shares that include that account's plan) and `status`.\nPage with `limit` and `cursor`. `changesRequestedCount` counts every share that is not revoked\nand has changes requested, whatever the filters. Each share's `url` is an empty string unless you have\nShare edit and the `share` permission.\n            \nErrors:\n            \n- `400 validation_failed`: `limit` is not from 1 to 200, `cursor` is invalid, or `status`\n  holds an unknown value.\n            \nRequires Share view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `share` feature on your workspace. Until it is on, calls answer 404.","operationId":"shares.list","parameters":[{"name":"limit","in":"query","description":"Number of shares per page, from 1 to 200, default 50.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"cursor","in":"query","description":"The `nextCursor` from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"campaignId","in":"query","description":"Only the shares of the campaign with this id. Omit it for every campaign.","schema":{"type":"integer","format":"int64"}},{"name":"accountId","in":"query","description":"Only the shares that include the plan of the account with this id. Omit it for every account.","schema":{"type":"integer","format":"int64"}},{"name":"status","in":"query","description":"Only the shares in these statuses, as a comma-separated list of `not_opened`, `viewed`,\n`n_of_m_approved`, `changes_requested` and `approved`. Omit it for every status.","schema":{"type":"string"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareListResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["share"],"x-ken-permission":{"kind":"page","page":"share","access":"view","summary":"Share view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"post":{"tags":["shares"],"summary":"Create a share","description":"Creates a share link, freezes a snapshot of each shared item, and emails the link to every recipient that is\nan email address. Returns `201` with the new share and its `url`.\n            \nSend `items` and `permission`. `campaignId` is required unless the share holds only account\nplans, and `accountIds` is required with `plan`. The request body fields list every option and its\nrules.\n            \nCopy is one item, lead lists are one item per active segment, and plans are one item per account. On an\napprove share, the copy and lead list items are the same approval items the campaign's launch waits on, so a\ndecision on the link also counts for launch. Kenso does not email a recipient that already got a share email\nfrom this workspace in the last 24 hours, and lists them in `alreadyEmailedRecipients`. Each address\nKenso emails counts against the workspace's daily share email cap.\n            \nErrors:\n            \n- `400 validation_failed`: a field is missing or invalid. A campaign with no copy or no active segment\n  gives an `items` detail with code `empty`, and an account that is not in this workspace gives an\n  `accountIds[n]` detail with code `not_found`.\n- `403 forbidden`: the caller is a workspace key. The share records the member who shared it, and a\n  workspace key is not a person.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `429 quota_exceeded`: the emails would pass the workspace's daily share email cap (detail code\n  `share_email_quota`). Kenso creates nothing and emails no one.\n            \nRequires Share edit and the `share` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `share` feature on your workspace. Until it is on, calls answer 404.","operationId":"shares.create","parameters":[{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShareInput"}}}},"responses":{"201":{"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"403":{"description":"Forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["forbidden"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["quota_exceeded","rate_limited"]}},"x-ken-features":["share"],"x-ken-permission":{"kind":"page","page":"share","access":"edit","features":["share"],"summary":"Share edit and the `share` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/shares/{shareId}":{"get":{"tags":["shares"],"summary":"Get a share","description":"Returns one share with its items, comments, access summary and log. `url` is an empty string unless you\nhave Share edit and the `share` permission.\n            \nErrors:\n            \n- `404 not_found`: no share with this id exists in this workspace, or it was revoked.\n            \nRequires Share view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `share` feature on your workspace. Until it is on, calls answer 404.","operationId":"shares.get","parameters":[{"name":"shareId","in":"path","description":"Id of the share.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["share"],"x-ken-permission":{"kind":"page","page":"share","access":"view","summary":"Share view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"patch":{"tags":["shares"],"summary":"Update a share","description":"Changes a share's settings. Fields you leave out stay as they are. You can change `name`,\n`company`, `recipients` (the list you send replaces the old one), `expiry` (counted from when\nthe share was created), `holdLaunch` and `recurringReport`. The shared items and the permission are\nfixed: create a new share to change them.\n            \nKenso does not email the link to recipients you add. Each new email address still counts against the\nworkspace's daily share email cap, because it gets the later reminders and weekly reports. When the update\nends the share's launch hold, Kenso resumes a campaign the hold kept paused, unless another approval still\nblocks it.\n            \nErrors:\n            \n- `400 validation_failed`: a field is invalid, such as a blank `name`, more than 20 recipients, or\n  `holdLaunch` on a share that is not an approve share with lead lists, copy or settings.\n- `404 not_found`: no share with this id exists in this workspace, or it was revoked.\n- `429 quota_exceeded`: the new addresses would pass the workspace's daily share email cap (detail code\n  `share_email_quota`). Kenso changes nothing.\n            \nRequires Share edit and the `share` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `share` feature on your workspace. Until it is on, calls answer 404.","operationId":"shares.update","parameters":[{"name":"shareId","in":"path","description":"Id of the share.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShareInput"}}}},"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["quota_exceeded","rate_limited"]}},"x-ken-features":["share"],"x-ken-permission":{"kind":"page","page":"share","access":"edit","features":["share"],"summary":"Share edit and the `share` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}},"delete":{"tags":["shares"],"summary":"Revoke a share","description":"Turns a share link off for good. The link then answers `410 share_inactive`, and the share leaves the\nlist. Decisions already made stay. If the share held a campaign's launch, Kenso resumes a campaign the hold\nkept paused, unless another approval still blocks it. Returns `204`.\n            \nErrors:\n            \n- `403 forbidden`: the caller is a workspace key. The revoke records the member who made it, and a\n  workspace key is not a person.\n- `404 not_found`: no share with this id exists in this workspace, or it was already revoked.\n            \nRequires Share edit and the `share` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `share` feature on your workspace. Until it is on, calls answer 404.","operationId":"shares.revoke","parameters":[{"name":"shareId","in":"path","description":"Id of the share.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"403":{"description":"Forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["forbidden"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"410":{"description":"Gone","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["share_inactive"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["share"],"x-ken-permission":{"kind":"page","page":"share","access":"edit","features":["share"],"summary":"Share edit and the `share` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/shares/preview":{"post":{"tags":["shares"],"summary":"Preview a new share","description":"Shows what a reviewer would see for a share you have not created yet. Send the same body as\n`POST /v1/shares`. Kenso builds the items the way create does, with copy rendered for sample contacts,\nbut saves nothing and emails no one.\n            \nItems in the preview are numbered from 1 and show as not reviewed. The exception is copy and lead lists on an\napprove share whose current version is already approved.\n            \nErrors:\n            \n- `400 validation_failed`: the body fails a check that `POST /v1/shares` makes.\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Share edit and the `share` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `share` feature on your workspace. Until it is on, calls answer 404.","operationId":"shares.preview-draft","parameters":[{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShareInput"}}}},"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharePublicResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["share"],"x-ken-permission":{"kind":"page","page":"share","access":"edit","features":["share"],"summary":"Share edit and the `share` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/shares/{shareId}/reminders":{"post":{"tags":["shares"],"summary":"Remind a share's recipients","description":"Emails the link again to the share's recipients that are email addresses, and logs a\n`share_reminder_sent` entry. Returns `202` with `recipientCount`, the number of addresses\nemailed.\n            \nKenso sends at most one reminder per share every 24 hours. It skips a recipient that got a share email from\nthis workspace in the last 24 hours, and lists them in `alreadyEmailedRecipients`. Each address Kenso\nemails counts against the workspace's daily share email cap.\n            \nErrors:\n            \n- `400 validation_failed`: the share has no recipients.\n- `403 forbidden`: the caller is a workspace key. The reminder records the member who sent it, and a\n  workspace key is not a person.\n- `404 not_found`: no share with this id exists in this workspace, or it was revoked.\n- `409 no_email_recipients`: every recipient is a name, so there is nobody to email.\n- `410 share_expired`: the share has expired.\n- `429 quota_exceeded`: the share got a reminder in the last 24 hours (detail code\n  `reminder_cooldown`), the emails would pass the daily share email cap (`share_email_quota`), or\n  every recipient got a share email in the last 24 hours (`recipients_emailed_today`). The response\n  carries `Retry-After`, and Kenso sends nothing.\n            \nRequires Share edit and the `share` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `share` feature on your workspace. Until it is on, calls answer 404.","operationId":"shares.remind","parameters":[{"name":"shareId","in":"path","description":"Id of the share.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"202":{"description":"Accepted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareReminderResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"403":{"description":"Forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["forbidden"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"409":{"description":"Conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["no_email_recipients"]},"410":{"description":"Gone","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["share_expired"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["quota_exceeded","rate_limited"]}},"x-ken-features":["share"],"x-ken-permission":{"kind":"page","page":"share","access":"edit","features":["share"],"summary":"Share edit and the `share` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/shares/{shareId}/preview":{"get":{"tags":["shares"],"summary":"Preview a share","description":"Returns the share page exactly as a reviewer sees it at the share's `url`, without counting a view. It\nworks on an expired share too.\n            \nErrors:\n            \n- `404 not_found`: no share with this id exists in this workspace, or it was revoked.\n            \nRequires Share view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `share` feature on your workspace. Until it is on, calls answer 404.","operationId":"shares.preview","parameters":[{"name":"shareId","in":"path","description":"Id of the share.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharePublicResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["share"],"x-ken-permission":{"kind":"page","page":"share","access":"view","summary":"Share view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Enter: Bearer {your Kenso API key}. Create one in the Kenso app under Settings > Integrations > API Keys.","scheme":"bearer","bearerFormat":"Opaque API key"}},"headers":{"RateLimit-Limit":{"description":"The request limit of the rate limit this request is closest to reaching: your plan's limit for this kind of call, your API key's own limit, or the operation's own limit, whichever has the fewest requests left.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The requests left under that limit. `0` on a `429`.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"The seconds until that limit resets.","schema":{"type":"integer"}}},"schemas":{"ApiKeyError":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A sentence for people that says what went wrong. It can change, so do not parse it."}},"additionalProperties":false,"description":"The body the API key check in front of the operations answered until November 2026, instead of the error body (`Failure`): `{ \"error\": \"Invalid or revoked API key\" }` on a `401`, `{ \"error\": \"Rate limit exceeded\" }` on a `429` and `{ \"error\": \"Authentication is temporarily unavailable\" }` on a `503`. It has no `code`, so branch on the HTTP status."},"CreateShareInput":{"required":["permission"],"type":"object","properties":{"name":{"type":"string","description":"Name of the share, at most 255 characters. Omitted, Kenso names it after the campaign and the shared items,\nsuch as \"Q4 RevOps · lead list and copy\".","nullable":true},"company":{"type":"string","description":"Who the share is for, shown on the share page, at most 255 characters. Omitted, it is the workspace name.","nullable":true},"campaignId":{"type":"integer","description":"Id of the campaign to share. Required unless `items` holds only `plan`.","format":"int64","nullable":true},"accountIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of the accounts whose plans to share, from 1 to 100. Required with `plan` and ignored without it.","nullable":true},"items":{"type":"array","items":{"type":"string"},"description":"What to share, at least one of: `leads` (the lead lists), `copy` (the email copy),\n`settings` (the campaign settings), `icp` (the targeting), `report` (the weekly report) and\n`plan` (account plans).","nullable":true},"permission":{"type":"string","description":"What reviewers can do: `view`, `comment` or `approve`. Required."},"expiry":{"type":"string","description":"How long the link works, counted from creation: `7_days`, `30_days` or `never`. Omitted means `30_days`.","nullable":true},"recipients":{"type":"array","items":{"type":"string"},"description":"Up to 20 email addresses or names, each at most 254 characters. Kenso emails the link to the email addresses\nand only records the names.","nullable":true},"holdLaunch":{"type":"boolean","description":"True keeps the campaign from launching or resuming until reviewers approve every item. Needs `approve`\nand a `leads`, `copy` or `settings` item. Defaults to false."},"recurringReport":{"type":"boolean","description":"True emails the recipients a fresh weekly report every Monday at 8 AM. Needs a `report` item. Defaults to false."}},"additionalProperties":false,"description":"The settings of a new share link, for a create or a draft preview."},"ErrorAccount":{"type":"object","properties":{"accountId":{"type":"integer","description":"The account's id.","format":"int64"},"name":{"type":"string","description":"The account's name."},"stakeholderId":{"type":"integer","description":"The person's stakeholder id on this account.","format":"int64"}},"additionalProperties":false,"description":"An account named in an error detail."},"ErrorBody":{"type":"object","properties":{"code":{"type":"string","description":"Stable error code, such as `validation_failed` or `not_found`. Branch on this value."},"message":{"type":"string","description":"A sentence for people that explains the error. It can change, so do not parse it."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"One entry per problem, naming the field or limit it is about. Omitted when there are none.","nullable":true},"requestId":{"type":"string","description":"The id of this request: the same value as the `X-Correlation-Id` response header. Quote it when you write\nto contact@ken.so."},"docUrl":{"type":"string","description":"The page on this code in the developer docs, which says what it means and how to fix it. The errors guide for a\ncode that has no page of its own.","readOnly":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"On a `402`, the plan rule or usage limit that refused the request and how to lift it. Omitted otherwise."},"impact":{"allOf":[{"$ref":"#/components/schemas/InvalidationImpact"}],"description":"On a `409` that refuses a change because it would clear stored AI output (a prompt edit, a restore or a\nreset), how much the change would clear. Omitted otherwise."},"surface":{"type":"string","description":"Set only by the voice ticket's `409` (code `voice_conversation_active`): the chat the person's other\nvoice conversation runs in, `support`, `ken` or `onboarding`. Omitted on every other error.","nullable":true}},"additionalProperties":false,"description":"What went wrong in a request."},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The request field, header or limit the problem is about, such as `name` or `Ken-Version`."},"code":{"type":"string","description":"Stable code for this problem, such as `required` or `invalid`."},"message":{"type":"string","description":"A sentence for people that explains this problem."},"count":{"type":"integer","description":"On `export_limit_exceeded`, how many rows match the export. Omitted otherwise.","format":"int32","nullable":true},"index":{"type":"integer","description":"The position of the refused item in the request's list. Omitted otherwise.","format":"int32","nullable":true},"limit":{"type":"integer","description":"On `export_limit_exceeded`, the row limit the export ran with. On a `quota_exceeded` detail whose\n`field` names a quota, that quota's limit. On a `rate_limited` detail from your workspace's rate\nlimits, the limit that was hit. Omitted otherwise.","format":"int32","nullable":true},"resetAt":{"type":"string","description":"On some `quota_exceeded` details, when the quota frees up, in UTC. It is the same instant as the top-level\n`quotaResetAt`. On a `rate_limited` detail from your workspace's rate limits, when that limit resets.\nOmitted otherwise.","format":"date-time","nullable":true},"retryAfterSeconds":{"type":"integer","description":"On those `quota_exceeded` details and on most `rate_limited` details, the seconds to wait. It is the\nsame value as the `Retry-After` header. Omitted otherwise.","format":"int32","nullable":true},"inboxId":{"type":"integer","description":"The inbox the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainId":{"type":"integer","description":"The domain the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The name of that domain, or the domain name the request gave. Omitted otherwise.","nullable":true},"accountId":{"type":"integer","description":"On `domain_taken`, `already_stakeholder` and `previously_removed`, the existing account to use\ninstead. Omitted otherwise.","format":"int64","nullable":true},"personId":{"type":"integer","description":"On `email_taken` and `linkedin_url_taken`, the existing person to use instead. Omitted otherwise.","format":"int64","nullable":true},"stakeholderId":{"type":"integer","description":"The account stakeholder the problem is about. Omitted otherwise.","format":"int64","nullable":true},"championId":{"type":"integer","description":"Not used. Always omitted.","format":"int64","nullable":true},"callTaskId":{"type":"integer","description":"On `call_task_exists`, the open call task that already holds the person's slot. Omitted otherwise.","format":"int64","nullable":true},"status":{"type":"string","description":"On `invalid_transition`, the current status. Omitted otherwise.","nullable":true},"allowed":{"type":"array","items":{"type":"string"},"description":"On `out_of_range`, the allowed values. On `invalid_transition`, the statuses the change is allowed\nfrom. Omitted otherwise.","nullable":true},"scope":{"type":"string","description":"On a `permission_denied` for an account owner change, the account scope the call needs (`all`). On\n`sending_paused`, what the pause covers: `inbox`, `domain` or `workspace`. Omitted otherwise.","nullable":true},"removedAt":{"type":"string","description":"On `previously_removed`, when a person removed the stakeholder, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"page":{"type":"string","description":"On `permission_denied`, the page the call needs, such as `campaigns`. Omitted otherwise.","nullable":true},"required":{"type":"string","description":"On `permission_denied`, the access `page` needs: `view` or `edit`. Omitted otherwise.","nullable":true},"feature":{"type":"string","description":"On `permission_denied`, the permission the call needs, such as `launch`. Omitted otherwise.","nullable":true},"runId":{"type":"integer","description":"On `committee_run_active` and `run_not_finding`, the committee run the problem is about. Omitted\notherwise.","format":"int64","nullable":true},"mergedIntoId":{"type":"integer","description":"On `person_merged`, the person the merged person now lives on. On `account_merged`, the account the\nmerged account now lives on. Omitted otherwise.","format":"int64","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAccount"},"description":"On `person_on_accounts`, the accounts that block the change. Omitted otherwise.","nullable":true},"stage":{"type":"string","description":"On `stage_in_use` and `system_stage`, the opportunity stage key the problem is about. Omitted otherwise.","nullable":true},"opportunityCount":{"type":"integer","description":"On `stage_in_use`, how many opportunities are in that stage. Omitted otherwise.","format":"int32","nullable":true},"rule":{"type":"string","description":"On `guardrail_violation`, the contact limit rule the change breaks. Omitted otherwise.","nullable":true},"nextAllowedAt":{"type":"string","description":"On `guardrail_violation`, the first `dueAt` that passes every contact limit, in UTC. On a refused\nsend, when to retry. Omitted otherwise, and when waiting does not clear it.","format":"date-time","nullable":true},"fix":{"type":"string","description":"On a refused send, what to do next, in plain words. Omitted otherwise.","nullable":true},"opensAt":{"type":"string","description":"On `outside_calling_hours`, when the person's calling window opens, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"On a knowledge file's `version_conflict`, the file's current version. Omitted otherwise.","format":"int32","nullable":true},"provider":{"type":"string","description":"On a CRM connection error (`provider_error`, `exchange_failed`, `already_connected`,\n`account_mismatch` or `provider_unavailable`), the CRM it is about. Omitted otherwise.","nullable":true},"sharedWithMaster":{"type":"boolean","description":"True on a `quota_exceeded` detail when the shared limit of the white-label master workspace was hit, so\n`limit` is the limit of the whole white-label account. Omitted otherwise. The master's id is never sent.","nullable":true},"stepId":{"type":"integer","description":"On `link_reputation_blocked`, the saved sequence step that holds the blocked link. Omitted otherwise, and\nfor a step the save would have created.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"On `link_reputation_blocked`, the `stepOrder` of that step. Omitted otherwise.","format":"int32","nullable":true},"url":{"type":"string","description":"On `link_reputation_blocked`, the blocked link as the step's copy writes it. Omitted otherwise.","nullable":true},"key":{"type":"string","description":"On `unfilled_template_key`, the template key the text still holds, such as `first_name` for\n`{first_name}`. Omitted otherwise.","nullable":true},"marker":{"type":"string","description":"On `unfilled_template_key`, that key as the text writes it, such as `{first_name}` or `[company]`.\nOmitted otherwise.","nullable":true},"retryAt":{"type":"string","description":"On a warm path Start's `guardrail_connector_monthly`, `guardrail_account_monthly`,\n`guardrail_connector_cooldown` and `guardrail_handoff_weekly`, when the limit frees up, in UTC. Omitted\notherwise.","format":"date-time","nullable":true},"workspaceId":{"type":"integer","description":"On `last_admin`, a workspace that needs a new admin before the account can be deleted. On\n`new_admin_not_found`, the workspace of the refused choice. Omitted otherwise.","format":"int64","nullable":true},"workspaceName":{"type":"string","description":"On `last_admin`, the name of that workspace. Omitted otherwise.","nullable":true},"class":{"type":"string","description":"On a `rate_limited` detail from your workspace's rate limits, the class of call that hit its limit:\n`read`, `write`, `bulk`, `heavy` or `sensitive`. Omitted otherwise.","nullable":true},"window":{"type":"string","description":"On that detail, the window whose limit was hit: `minute`, `day` or `bulkItemsDay`. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One problem in an error: the field or limit it is about, a stable `code` and a `message`. The other fields\nappear only with the codes their descriptions name."},"Failure":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on an error."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"What went wrong."},"quotaResetAt":{"type":"string","description":"When the quota that refused the request frees up, in UTC. Set on some quota refusals. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"The current revision of a workflow draft, on a draft save's `409 version_conflict`. Read the workflow\nagain, then send this value as `baseVersion`. Omitted otherwise.","format":"int32","nullable":true},"current":{"allOf":[{"$ref":"#/components/schemas/MeetingRepNotesCurrent"}],"description":"Your meeting notes and their version as stored now, on a meeting notes save's `409 version_conflict`.\nMerge your change, then save again with `baseVersion` set to `current.repNotesVersion`. Omitted\notherwise."},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"A copy of `error.refusal`, set on some billing refusals. Omitted otherwise."},"message":{"type":"string","description":"A copy of `error.message`, set together with `refusal`. Omitted otherwise.","nullable":true},"lookalikeSeeds":{"description":"How Kenso read each seed of a lookalike search, on its `422 no_usable_seeds`:\n`{resolved: [{input, companyId, personId, name, domain}], unresolved: [{input, reason}]}`. Use it to show\nwhy no seed was usable. Omitted otherwise."}},"additionalProperties":false,"description":"The body of every error, with a 4xx or 5xx status. Branch on `error.code`."},"InvalidationImpact":{"type":"object","properties":{"qualificationResponses":{"type":"integer","description":"Stored qualification answers the change would clear.","format":"int32"},"qualifiedFlags":{"type":"integer","description":"Contacts whose qualified result the change would clear.","format":"int32"},"segmentationReasoning":{"type":"integer","description":"Stored segmentation explanations the change would clear.","format":"int32"},"segmentationAssignmentsKept":{"type":"integer","description":"Contacts that keep their segment.","format":"int32"},"segmentationAssignmentsReset":{"type":"integer","description":"Contacts that go back to the default segment.","format":"int32"},"personalizationLines":{"type":"integer","description":"Personalized lines the change would clear.","format":"int32"},"personalizationLeads":{"type":"integer","description":"Contacts that would lose their personalized lines.","format":"int32"},"rewritingLines":{"type":"integer","description":"Rewritten lines the change would clear.","format":"int32"},"rewritingLeads":{"type":"integer","description":"Contacts that would lose their rewritten lines.","format":"int32"}},"additionalProperties":false,"description":"How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it\nkeeps or resets."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"Pagination":{"type":"object","properties":{"nextCursor":{"type":"string","description":"Send this value as `cursor` to get the next page. Omitted on the last page.","nullable":true},"hasMore":{"type":"boolean","description":"True when more items follow this page. Stop paging when it is false."},"total":{"type":"integer","description":"Deprecated: the same number as `totalCount`. Read `totalCount`.","format":"int32","nullable":true,"deprecated":true},"totalCount":{"type":"integer","description":"The number of items that match the list's filters, across all pages. Omitted when the list does not count them.","format":"int32","nullable":true},"isTotalCapped":{"type":"boolean","description":"True when `totalCount` stopped counting at its cap, so more items match than it says. Keep paging with\n`hasMore`. Omitted when `totalCount` is exact. Only `GET /v1/threads` with `q` caps its total.","nullable":true}},"additionalProperties":false,"description":"Where a list page ends and how to get the next page."},"RateLimitedText":{"type":"string","description":"The gateway's plain-text body of a `429` over the operation's own limit, until November 2026: `Number of requests exceeded. Please try again later.`","example":"Number of requests exceeded. Please try again later."},"Refusal":{"type":"object","properties":{"code":{"type":"string","description":"Stable refusal code in upper case, such as `CAMPAIGN_LIMIT_REACHED` or `INSUFFICIENT_CREDITS`."},"metric":{"type":"string","description":"What the limit counts: `Campaigns`, `Leads`, `Emails`, `LinkedInSeats` or `AiCredits`,\n`jobs_export_rows` or `funding_export_rows` for an export allowance, `credit_pack_credits`,\n`credit_spend_usd_7d`, `domains` or `mailboxes` for a limit on a new paying workspace, or for a\nKenso Lifetime cap its key: `workspaces`, `inboxes`, `contacts`, `email_verifications_day`,\n`email_verifications_month`, `people_results_day`, `company_results_day`,\n`funding_results_day`, `job_post_results_day`, `website_visits_month` or\n`visitor_lookups_day`. Omitted when a plan rule, not a count, refused the request.","nullable":true},"used":{"type":"integer","description":"How much of the limit is used, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"limit":{"type":"integer","description":"The limit, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"remaining":{"type":"integer","description":"How much of the limit is left, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"planType":{"type":"string","description":"The workspace's plan as its snake plan id, for example `free`, `legacy_core` or `growth`."},"remedy":{"type":"string","description":"What lifts the refusal: `Upgrade`, `BuyAddOn`, `UpdatePaymentMethod` or `ContactSupport`.\n`None` means no action of yours lifts it."},"unlocksAt":{"type":"string","description":"When the limit lifts by itself, in UTC: for a limit on a new paying workspace once it has paid an invoice, and for\na Kenso Lifetime daily or monthly cap its reset (00:00 UTC, or the 1st of the month). Omitted on every other\nrefusal.","format":"date-time","nullable":true},"requiredMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits the action needed. 1,000 millicredits are one credit. Omitted on every\nother refusal.","format":"int64","nullable":true},"availableMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits available. On `FREE_CREDITS_NOT_ELIGIBLE`, only the credits that may\npay for inboxes and domains. Omitted on every other refusal.","format":"int64","nullable":true},"restrictedMillicredits":{"type":"integer","description":"On `FREE_CREDITS_NOT_ELIGIBLE`, the free and bonus millicredits in the balance that cannot pay for inboxes\nand domains. Omitted on every other refusal.","format":"int64","nullable":true},"feature":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the plan feature the plan does not include, in snake case (for example\n`website_visitor_id`). Omitted on every other refusal.","nullable":true},"requiredPlan":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the cheapest plan that includes `feature`, in snake case (for example\n`growth`). For a feature the self-serve trial locks (`browser_runs`), the trial's own plan,\nwhich paying for unlocks it. Omitted on every other refusal.","nullable":true},"requiredTier":{"type":"integer","description":"On a Kenso Lifetime refusal, the lowest tier that lifts it: the next tier with a higher cap, or the lowest tier\nthat includes `feature`. Omitted at the top tier, when no tier includes the feature, and on every other\nrefusal.","format":"int32","nullable":true},"upgradeUrl":{"type":"string","description":"On a Kenso Lifetime refusal that a higher tier lifts, the AppSumo page where the buyer upgrades their license.\nOmitted until Kenso has read that page from AppSumo, when no tier lifts the refusal, and on every other refusal.","nullable":true}},"additionalProperties":false,"description":"Why a plan rule or usage limit refused the request, and how to lift it."},"Share":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the share.","format":"int64"},"name":{"type":"string","description":"Name of the share. Reviewers see it on the share page."},"company":{"type":"string","description":"Who the share is for, shown on the share page. Defaults to the workspace name."},"url":{"type":"string","description":"The link to send, in the form `https://<app host>/s/<token>`. Anyone with the link can act\non the share. Empty unless you have Share edit and the `share` permission."},"campaignId":{"type":"integer","description":"Id of the shared campaign. Null when the share holds only account plans.","format":"int64","nullable":true},"campaignName":{"type":"string","description":"Name of the shared campaign. Null when the share has no campaign.","nullable":true},"accountIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of the accounts whose plans are shared, in the order picked. Omitted when the share has no plans.","nullable":true},"kinds":{"type":"array","items":{"type":"string"},"description":"What the share holds, in page order: `leads`, `copy`, `settings`, `icp`, `report` and `plan`."},"permission":{"type":"string","description":"What reviewers can do: `view`, `comment` or `approve`."},"expiry":{"type":"string","description":"How long the link works, counted from creation: `7_days`, `30_days` or `never`."},"expiresAt":{"type":"string","description":"When the link expires, in UTC. Null when it never expires.","format":"date-time","nullable":true},"isExpired":{"type":"boolean","description":"True once `expiresAt` has passed and the link no longer works."},"holdLaunch":{"type":"boolean","description":"True when the campaign cannot launch or resume until reviewers approve every item."},"recurringReport":{"type":"boolean","description":"True when Kenso emails the recipients a fresh weekly report every Monday at 8 AM."},"recipients":{"type":"array","items":{"type":"string"},"description":"The email addresses and names the share is for. Kenso emails only the email addresses."},"unsubscribedRecipients":{"type":"array","items":{"type":"string"},"description":"The email addresses in `recipients` that unsubscribed from this workspace's share emails, as written in\n`recipients`. Kenso sends them no share email: no link, reminder or weekly report."},"status":{"type":"string","description":"Where the review stands: `not_opened`, `viewed`, `n_of_m_approved` (some kinds approved, none\nwith changes requested), `changes_requested` or `approved`. View and comment shares only show\n`not_opened` or `viewed`."},"approvedCount":{"type":"integer","description":"Number of kinds approved, as in \"2 of 3 approved\". Always 0 on view and comment shares.","format":"int32"},"kindCount":{"type":"integer","description":"Number of kinds on the share.","format":"int32"},"changesRequestedCount":{"type":"integer","description":"Number of kinds with changes requested.","format":"int32"},"kindStatuses":{"type":"array","items":{"$ref":"#/components/schemas/ShareKindStatus"},"description":"One review status per kind on the share, in page order."},"viewCount":{"type":"integer","description":"Number of times the link was opened. Previews through `GET /v1/shares/{shareId}/preview` do not count.","format":"int32"},"firstViewedAt":{"type":"string","description":"When a reviewer first opened the link, in UTC. Null until then.","format":"date-time","nullable":true},"lastViewedAt":{"type":"string","description":"When a reviewer last opened the link, in UTC. Null until then.","format":"date-time","nullable":true},"submittedAt":{"type":"string","description":"When a reviewer sent the review, in UTC. Null until then. After that, the decisions cannot be undone.","format":"date-time","nullable":true},"submittedByName":{"type":"string","description":"Name the reviewer gave when they sent the review.","nullable":true},"lastReportSentAt":{"type":"string","description":"When the share last got a fresh weekly report, in UTC. Null when the share has no report.","format":"date-time","nullable":true},"createdByUserId":{"type":"integer","description":"Id of the member who created the share. Null when unknown.","format":"int64","nullable":true},"createdAt":{"type":"string","description":"When the share was created, in UTC.","format":"date-time"},"lastActivityAt":{"type":"string","description":"When anything last happened on the share, in UTC: created, viewed, a decision, a comment, a reminder, a report\nsent or the review sent.","format":"date-time"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ShareItem"},"description":"The shared items with their review status. Returned by get, create and update, and omitted from the list.","nullable":true},"comments":{"type":"array","items":{"$ref":"#/components/schemas/ShareComment"},"description":"The comments left through this share, oldest first. Returned by get, create and update, and omitted from the list.","nullable":true},"access":{"type":"array","items":{"$ref":"#/components/schemas/ShareAccessRow"},"description":"What reviewers may do, as label and value rows: \"They can\", \"Expires\", \"Launch\", \"Repeats\" and \"Branding\".\nReturned by get, create and update, and omitted from the list.","nullable":true},"activity":{"type":"array","items":{"$ref":"#/components/schemas/ShareActivity"},"description":"The share's log, newest first, at most 50 entries. Returned by get, create and update, and omitted from the list.","nullable":true},"alreadyEmailedRecipients":{"type":"array","items":{"type":"string"},"description":"On create only: the recipients Kenso did not email, because a share email from this workspace reached them in\nthe last 24 hours. Send them the link yourself. Omitted when Kenso emailed everyone.","nullable":true}},"additionalProperties":false,"description":"A share link. The list leaves out `items`, `comments`, `access` and `activity`."},"ShareAccessRow":{"type":"object","properties":{"label":{"type":"string","description":"Row label, such as \"They can\" or \"Expires\"."},"value":{"type":"string","description":"Row text, such as \"View and comment\" or \"30 days after sharing\"."}},"additionalProperties":false,"description":"One row of a share's access summary."},"ShareActivity":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the entry.","format":"int64"},"type":{"type":"string","description":"What happened, such as `share_created`, `share_viewed`, `approved`, `changes_requested`,\n`commented`, `decision_undone`, `share_submitted`, `share_reminder_sent` or\n`report_sent`. Other types can appear, so handle unknown values."},"shareItemId":{"type":"integer","description":"Id of the share item the entry is about. Omitted for an entry about the whole share.","format":"int64","nullable":true},"actorKind":{"type":"string","description":"Who acted: `user` (a workspace member), `reviewer` (someone using the link) or `system` (Kenso)."},"actorName":{"type":"string","description":"Name of the person who acted, when known.","nullable":true},"actorUserId":{"type":"integer","description":"Id of the member who acted. Null unless `actorKind` is `user`.","format":"int64","nullable":true},"data":{"description":"Details of the entry as a JSON object. Its keys depend on `type`. Null when there are none."},"createdAt":{"type":"string","description":"When it happened, in UTC.","format":"date-time"}},"additionalProperties":false,"description":"One entry in a share's log."},"ShareComment":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the comment.","format":"int64"},"shareItemId":{"type":"integer","description":"Id of the share item the comment is on.","format":"int64"},"anchor":{"type":"string","description":"The step, variant or paragraph the comment points at. Null when it is about the whole item.","nullable":true},"body":{"type":"string","description":"Text of the comment."},"authorName":{"type":"string","description":"Name the author gave."},"createdAt":{"type":"string","description":"When the comment was left, in UTC.","format":"date-time"}},"additionalProperties":false,"description":"A comment on a shared item."},"ShareItem":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the item on this share.","format":"int64"},"kind":{"type":"string","description":"The kind: `leads`, `copy`, `settings`, `icp`, `report` or `plan`."},"title":{"type":"string","description":"Title reviewers see for the item."},"status":{"type":"string","description":"Review status: `approved`, `changes_requested`, `not_reviewed`, `view_only` (a view or\ncomment share, with nothing to decide) or `changed` (the shared content changed after the share was made)."},"approvalItemId":{"type":"integer","description":"Id of the approval item behind this share item. Read it with `GET /v1/client-approvals/items/{itemId}`.","format":"int64"},"decidedAt":{"type":"string","description":"When the item was approved or sent back for changes, in UTC. Null while undecided.","format":"date-time","nullable":true},"decidedByName":{"type":"string","description":"Name of the person who decided.","nullable":true},"decisionComment":{"type":"string","description":"Comment left with the decision. Null when there is none.","nullable":true},"commentCount":{"type":"integer","description":"Number of comments on the item.","format":"int32"}},"additionalProperties":false,"description":"One item on a share. Lead lists give one item per segment, and plans one item per account."},"ShareKindStatus":{"type":"object","properties":{"kind":{"type":"string","description":"The kind: `leads`, `copy`, `settings`, `icp`, `report` or `plan`."},"status":{"type":"string","description":"Review status: `approved`, `changes_requested`, `not_reviewed`, `view_only` (a view or\ncomment share, with nothing to decide) or `changed` (the shared content changed after the share was made)."}},"additionalProperties":false,"description":"The review status of one kind on a share."},"ShareListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a successful response."},"data":{"type":"array","items":{"$ref":"#/components/schemas/Share"},"description":"The shares on this page, newest first, without their `items`, `comments`, `access` and `activity`."},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging state. Pass `nextCursor` as `cursor` to read the next page."},"changesRequestedCount":{"type":"integer","description":"Number of shares that are not revoked and have changes requested. The filters do not apply to it.","format":"int32"}},"additionalProperties":false,"description":"A page of shares, plus the workspace's count of shares with changes requested."},"SharePublic":{"type":"object","properties":{"brand":{"allOf":[{"$ref":"#/components/schemas/SharePublicBrand"}],"description":"The branding on the share page."},"workspaceName":{"type":"string","description":"Name of the workspace that shared the link."},"workspaceLogoUrl":{"type":"string","description":"URL of the workspace's wide logo, else its square icon. Omitted when it has neither.","nullable":true},"workspaceIconUrl":{"type":"string","description":"URL of the workspace's square icon, else its wide logo. Omitted when it has neither.","nullable":true},"shareName":{"type":"string","description":"Name of the share."},"company":{"type":"string","description":"Who the share is for."},"senderName":{"type":"string","description":"Name of the member who created the share. Omitted when unknown.","nullable":true},"campaignName":{"type":"string","description":"Name of the shared campaign. Null when the share has no campaign.","nullable":true},"permission":{"type":"string","description":"What reviewers can do: `view`, `comment` or `approve`."},"expiresAt":{"type":"string","description":"When the link expires, in UTC. Null when it never expires.","format":"date-time","nullable":true},"holdLaunch":{"type":"boolean","description":"True when the campaign cannot launch or resume until reviewers approve every item."},"isSubmitted":{"type":"boolean","description":"True once a reviewer sent the review."},"submittedAt":{"type":"string","description":"When a reviewer sent the review, in UTC. Null until then.","format":"date-time","nullable":true},"submittedByName":{"type":"string","description":"Name the reviewer gave when they sent the review.","nullable":true},"status":{"type":"string","description":"Where the review stands: `not_opened`, `viewed`, `n_of_m_approved`, `changes_requested`\nor `approved`."},"approvedCount":{"type":"integer","description":"Number of kinds approved. Always 0 on view and comment shares.","format":"int32"},"kindCount":{"type":"integer","description":"Number of kinds on the share.","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SharePublicItem"},"description":"The shared items in page order, each with its content and comments."}},"additionalProperties":false,"description":"The share page as a reviewer sees it at the share's `url`."},"SharePublicBrand":{"type":"object","properties":{"productName":{"type":"string","description":"Product name shown on the page."},"logoUrl":{"type":"string","description":"URL of the logo shown on the page."},"faviconUrl":{"type":"string","description":"URL of the page's favicon."},"accentColor":{"type":"string","description":"The agency's accent color as `#RRGGBB`; null when the workspace is not white-labeled or set none, and while\n`onboarding_v5` is off for it.","nullable":true}},"additionalProperties":false,"description":"The branding on a share page, from the workspace's white-label settings."},"SharePublicItem":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the item on this share.","format":"int64"},"kind":{"type":"string","description":"The kind: `leads`, `copy`, `settings`, `icp`, `report` or `plan`."},"title":{"type":"string","description":"Title reviewers see for the item."},"status":{"type":"string","description":"Review status: `approved`, `changes_requested`, `not_reviewed`, `view_only` (a view or\ncomment share, with nothing to decide) or `changed` (the shared content changed after the share was made)."},"canUndo":{"type":"boolean","description":"True when the reviewer can undo this item's decision: they made it from this link, the review is not sent yet,\nthere is no newer version, and it is not an approved copy, lead list or settings item of a campaign that is\nalready running."},"decidedAt":{"type":"string","description":"When the item was approved or sent back for changes, in UTC. Null while undecided.","format":"date-time","nullable":true},"decidedByName":{"type":"string","description":"Name of the person who decided.","nullable":true},"decisionComment":{"type":"string","description":"Comment left with the decision. Null when there is none.","nullable":true},"snapshot":{"description":"The item's content as a JSON object with camelCase keys, frozen when the item was created. Its shape depends\non `kind`: the campaign settings, the ICP, the weekly report, an account plan, the copy or a lead list."},"comments":{"type":"array","items":{"$ref":"#/components/schemas/ShareComment"},"description":"Comments on the item."}},"additionalProperties":false,"description":"One shared item as a reviewer sees it."},"SharePublicResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SharePublic"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ShareReminder":{"type":"object","properties":{"shareId":{"type":"integer","description":"Id of the share.","format":"int64"},"recipientCount":{"type":"integer","description":"Number of recipients Kenso emailed. Names are never emailed, and neither is anyone in\n`alreadyEmailedRecipients`.","format":"int32"},"remindedAt":{"type":"string","description":"When Kenso sent the reminder, in UTC.","format":"date-time"},"alreadyEmailedRecipients":{"type":"array","items":{"type":"string"},"description":"The recipients Kenso skipped, because a share email from this workspace reached them in the last 24 hours."}},"additionalProperties":false,"description":"The result of a share reminder."},"ShareReminderResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ShareReminder"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ShareResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Share"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"TooManyRequestsError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The JSON body of a `429`: the error body (`Failure`), with code `rate_limited` or `quota_exceeded`, over your workspace's rate limits, your API key's own limit, the operation's own limit or a usage quota. Until November 2026, over your API key's own limit the API key check answered `{ \"error\": \"Rate limit exceeded\" }` (`ApiKeyError`), and over the operation's own limit the gateway answered plain text (`RateLimitedText`): `Number of requests exceeded. Please try again later.` A client built against those answers keeps working: handle each shape. Wait the `Retry-After` seconds."},"UnauthorizedError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The body of a `401`: the error body (`Failure`), whose `code` says what is wrong with the credential. Until November 2026, when the API key was not valid (unknown, expired or revoked, or its member no longer active), the API key check in front of the operations answered `{ \"error\": \"Invalid or revoked API key\" }` (`ApiKeyError`), and a request with no API key got a `401` that has no body. A client built against those answers keeps working: handle both shapes and a `401` with no body."},"UpdateShareInput":{"type":"object","properties":{"name":{"type":"string","description":"New name of the share, at most 255 characters. It cannot be blank.","nullable":true},"company":{"type":"string","description":"Who the share is for, shown on the share page, at most 255 characters.","nullable":true},"recipients":{"type":"array","items":{"type":"string"},"description":"The full recipient list, up to 20 email addresses or names. It replaces the old list. Kenso does not email\nthe link to new recipients, but they get later reminders and weekly reports.","nullable":true},"expiry":{"type":"string","description":"How long the link works: `7_days`, `30_days` or `never`, counted from when the share was created, not from now.","nullable":true},"holdLaunch":{"type":"boolean","description":"True keeps the campaign from launching or resuming until reviewers approve every item. Needs an approve share\nwith a `leads`, `copy` or `settings` item.","nullable":true},"recurringReport":{"type":"boolean","description":"True emails the recipients a fresh weekly report every Monday at 8 AM. Needs a `report` item.","nullable":true}},"additionalProperties":false,"description":"The share settings to change. A field you leave out stays as it is."}}}}