{"openapi":"3.0.4","info":{"title":"Kenso API: Threads","version":"1.1","description":"The Threads 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":"threads","description":"A thread is one conversation in the workspace's inbox: an email thread, or a LinkedIn, Instagram, Facebook, WhatsApp or iMessage conversation, with `thr_` ids for threads and `msg_` ids for messages. List threads and read their messages, count them by inbox tab, and label, archive, save, mark read or set reminders on one thread or up to 1,000 at once, or mark every unread thread read. Keep a reply draft, send replies and forwards, or start a new email thread from a shared inbox. An email reply or forward waits in an undo window before it sends, and `POST /v1/scheduled-messages/{scheduledMessageId}/cancel` stops it there.","x-displayName":"Threads"}],"paths":{"/v1/threads":{"get":{"tags":["threads"],"summary":"List threads","description":"Lists the workspace's inbox threads, one row per thread, newest first. Each row shows the thread's newest message\nin the tab you ask for. `limit` is 50 by default and at most 100. `channel` is `email`,\n`linkedin`, `instagram`, `whatsapp`, `facebook` or `all` (the default), and\n`imessage` while the workspace's `imessage` flag is on; then `all` lists iMessage threads too.\n            \nPick the tab with `status` and `folder`. To Reply (`status=to_reply`) lists campaign threads whose\nnewest reply is `interested`, `objection`, `wrong_contact` or `referral`, plus threads whose\nreminder came due. A thread leaves To Reply once your reply is its newest message and comes back with the\ncontact's next reply. `source` narrows a tab to account threads or campaign threads, as\n`accountsCount` and `campaignsCount` on `GET /v1/threads/counts` count them.\n            \nKenso applies `contactId`, `inboxId`, `interest` and `hasReminder` before paging, so\n`hasMore` and `pagination.totalCount` count only matching threads. On `folder=all` a row is the newest\nmessage in either direction, and a message you sent has no label and no reminder. To filter threads by their\nnewest reply, list with `folder=inbox`.\n            \niMessage threads have no campaign, tags or reminder, and a contact filter never matches them, so\n`campaignId`, `tagIds`, `contactId`, `hasReminder=true` and `source=campaigns` list none\nof them (an iMessage row's `contactId` is its person's newest contact, for display). An iMessage row's\n`inboxId` is its line's id, and `inboxId` matches that line.\n            \n`pagination.totalCount` counts threads, the same number as `allCount` on `GET /v1/threads/counts`.\nWith `q` the total stops at 1,000: past that it reads 1,000, `pagination.isTotalCapped` is true, and you\ncan keep paging while `hasMore` is true.\n            \n`sort=oldest_waiting` lists the thread that has waited longest first, across pages. `groupBy=person`\nlists one row per person instead of one per thread, and `personKey` lists one person's threads. Both add the\nperson fields to each row.\n            \n`includeTotal=false` leaves the total out of `pagination`, and the list of every channel without\n`q`, `groupBy` or `personKey` then skips its count, except on an inbound tab, whose page reads its\ncount with its rows. `bodyFormat=snippet` returns each row without\n`htmlBody` and with `preview` cut to 280 characters of text, and `bodyFormat=none` without either.\nSend a `nextCursor` back with the same filters, `sort` and `includeTotal` it came with.\n            \n`channel=facebook` lists Facebook threads, only chats with a person of this workspace (never a group), and\ntakes `limit`, `cursor`, `isRead`, `includeTotal` and `bodyFormat` only; any other filter is `400 validation_failed` on that\nfield. When Facebook outreach is off for the workspace it is `400` like any unknown channel.\n`channel=all` lists email and LinkedIn threads, plus matched Instagram and WhatsApp chats while the workspace\nhas those channels on, and iMessage threads while `imessage` is on, and never Facebook threads.\n            \nErrors:\n            \n- `400 validation_failed`: `limit` is outside 1 to 100, `cursor` is invalid, or\n`channel`, `interest`, `source`, `sort`, `groupBy`, `personKey` or\n`bodyFormat` is not a known value.\n            \nRequires Inbox view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"threads.list","parameters":[{"name":"channel","in":"query","description":"The channel: `email`, `linkedin`, `instagram`, `whatsapp`, `facebook` or `all`,\nand `imessage` while the workspace's imessage flag is on. Omitted, it is `all`. Instagram, WhatsApp\nand iMessage chats are listed only while the workspace has that channel on.","schema":{"type":"string"}},{"name":"campaignId","in":"query","description":"Only this campaign's threads. iMessage threads never match it.","schema":{"type":"integer","format":"int64"}},{"name":"inboxId","in":"query","description":"Only threads whose `inboxId` is this id: a LinkedIn thread's LinkedIn account, an iMessage thread's line,\nor the workspace inbox an email row's message was sent to or from. These ids can repeat across channels, so on\n`channel=all` the id matches any of them. Pass `channel` to stay on one.","schema":{"type":"integer","format":"int64"}},{"name":"contactId","in":"query","description":"Only threads with this `contactId`, as each row carries it: the stored contact, or for a LinkedIn\nconversation stored without one, the contact its person matches. iMessage threads never match it.","schema":{"type":"integer","format":"int64"}},{"name":"interest","in":"query","description":"Only threads whose row carries this label: `interested`, `question`, `not_interested`, `negative`,\n`automated`, `unclassified`, `unsubscribe`, `objection`, `wrong_contact`,\n`out_of_office` or `referral`. `not_interested` also matches `negative`. Under\n`folder=all` a row is the newest message in either direction, and a message you sent has no label, so a\nthread you already answered matches only `unclassified`. To filter by each thread's newest reply, list with\n`folder=inbox`.","schema":{"type":"string"}},{"name":"status","in":"query","description":"The inbox tab: `to_reply`, `other`, `automated_reply`, `not_interested` or\n`human_reply`. Kenso applies it before paging. Any other value is ignored.","schema":{"type":"string"}},{"name":"folder","in":"query","description":"The folder: `inbox` (replies you received), `sent` (messages you sent) or `all` (both).\nOmitted, it is `inbox`.","schema":{"type":"string"}},{"name":"source","in":"query","description":"Narrows the tab to `accounts` (threads of an account touch) or `campaigns` (campaign threads), the same\nsplit as\n`accountsCount` and `campaignsCount` on `GET /v1/threads/counts`. Omitted lists every thread of\nthe tab. Any other value is `400 validation_failed`.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"The order. `oldest_waiting` lists the thread that has waited longest first, across pages: by each row's\n`waitingSince`, else its newest message. Omitted keeps the inbox order, newest first. Any other value is\n`400 validation_failed`.","schema":{"type":"string"}},{"name":"groupBy","in":"query","description":"Set to `person` to list one row per person, the person's newest thread in the tab. Each row adds `personKey`,\n`personId`, `personName`, `channels`, `waitingCount` and `threadIds`, and\n`pagination.totalCount` counts people. With `q` the total stops at 1,000 people. On `folder=sent` or\n`folder=all`, in the default order and without `q`, Kenso counts only the people among the newest\nmessages it read for the page. When `pagination.isTotalCapped` is true, show the total as a lower bound and\npage while `hasMore` is true. With `sort=oldest_waiting` a person sorts by their longest wait in the\ntab, and the row stays their newest thread. Omitted lists one row per thread. Any other value is\n`400 validation_failed`.","schema":{"type":"string"}},{"name":"personKey","in":"query","description":"A row's `personKey` (`per_`, `con_` or `thr_`): lists every thread of that person,\narchived or not, newest first, each with the person fields of `groupBy=person`. It covers every folder\nunless you pass `folder` or `status`, and other filters still apply. A malformed key is\n`400 validation_failed`.","schema":{"type":"string"}},{"name":"isRead","in":"query","description":"True lists read threads, false unread ones. Omitted lists both.","schema":{"type":"boolean"}},{"name":"isArchived","in":"query","description":"True lists archived threads, false the rest. Omitted lists both.","schema":{"type":"boolean"}},{"name":"isSaved","in":"query","description":"True lists saved threads, false the rest. Omitted lists both.","schema":{"type":"boolean"}},{"name":"hasReminder","in":"query","description":"True lists threads whose row carries a reminder (never an iMessage thread), false those whose row carries none.\nUnder `folder=all` a row is the newest message in either direction, and a message you sent has no reminder.\nTo filter by each thread's newest reply, list with `folder=inbox`.","schema":{"type":"boolean"}},{"name":"tagIds","in":"query","description":"Only threads with any of these tag ids. Repeat the parameter for each id. iMessage threads never match it.","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"q","in":"query","description":"Search text. It matches the subject and body, the sender's domain, a recipient's email address, and the company\nname or domain. A term under 3 characters matches whole words of the subject and body only.","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The `nextCursor` from the previous page. Omit it for the first page. Send it with the same filters,\n`sort` and `includeTotal` as the request that returned it.","schema":{"type":"string"}},{"name":"includeTotal","in":"query","description":"False leaves `pagination.totalCount`, `total` and `isTotalCapped` out, and the list of every\nchannel (`channel` omitted or `all`) without `q`, `groupBy` or `personKey` then skips its\ncount, except on an inbound tab, whose page reads its count with its rows: page while `hasMore` is true.\nOmitted or true, every page carries the total.","schema":{"type":"boolean"}},{"name":"bodyFormat","in":"query","description":"How much of each row's newest message to return. `full` (the default) returns `preview` and\n`htmlBody` whole. `snippet` leaves `htmlBody` out and cuts `preview` to the first 280\ncharacters of the message's text, on one line. `none` leaves both out. Read a whole message with\n`GET /v1/threads/{threadId}/messages`. Any other value is `400 validation_failed`.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Threads per page, from 1 to 100. Omitted, it is 50.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":50}},{"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/PersonThreadListResponse"}}}},"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-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"post":{"tags":["threads"],"summary":"Start an email thread","description":"Sends a new email to one person from one of the workspace's shared cold inboxes, which starts a thread. Use it\nwhen an agent or an integration opens a conversation outside a campaign. A member's own mailbox cannot send it.\n            \n`senderInboxId`, `to.address`, `subject` and `body` are required, and the body is HTML. The\n`Idempotency-Key` header is required, from 1 to 200 characters. A retry with the same key and the same\nrequest returns the first message with `201` and sends nothing.\n            \nKenso checks each send against the workspace's sending rules first: the inbox's daily limit, pauses and blocks,\nthe contact's suppression, the workspace's contact limits, the content rules and the agent send quota. A refusal\nis an error whose `details[0].code` names the reason, with a `fix` that says what to do. When a later\nretry can work, the detail also carries `nextAllowedAt` and the response a `Retry-After` header.\n            \nAn inbox that has not finished warmup still sends. The `201` then carries a `warnings` entry with code\n`warmup_not_ready`, a `reason` of `too_young` or `unconfirmed`, a `fix`, and\n`readyAt` for `too_young`. A replay carries no warnings. Kenso records the send only after the email\nprovider accepts it.\n            \nErrors:\n            \n- `400 validation_failed`: a required field or the `Idempotency-Key` header is missing, the key is\nlonger than 200 characters, the recipient is not one valid address, the inbox cannot send for an agent or API key,\nor the content breaks a cold email rule.\n- `402 plan_limit_reached`: the workspace has no sends or credits left, or a Free plan rule refuses the send.\n- `402 free_plan_sending_needs_plan`: the workspace is on the Free plan, which sends nothing for a workspace\ncreated after the Free no-send rule started. `error.refusal` has `code`\n`FREE_PLAN_SENDING_NEEDS_PLAN` and `remedy` `Upgrade`: pick a paid plan, then send again.\n- `403 forbidden`: agent sending or 1:1 sending is not turned on for this workspace.\n- `404 not_found`: the inbox is not in this workspace.\n- `409 in_progress`: a send under this key is still running. Retry after the `Retry-After` header,\n30 seconds.\n- `409 outcome_unknown`: Kenso cannot tell whether the provider took the email, and never resends it. Read\nthe inbox's threads with the person before you send again under a new key.\n- `409 invalid_state`: the inbox is paused, blocked or not connected, the person must not be emailed, the\nworkspace holds replies or campaign copy for client approval, or the provider refused the email.\n- `422 idempotency_key_reused`: the key was used for another request. This operation answered `409`\nfor it before 2026-11-17.\n- `422 guardrail_violation`: the send breaks one of the workspace's contact limits. With\n`agent_contact_limit_override` on for the workspace, an agent's `overrideContactLimits: true` sends it\nanyway (not an API key's).\n- `429 rate_limited`: the inbox has no sends left today, sent a new email less than 5 minutes ago, or the\nworkspace used up its agent send quota.\n- `503 service_unavailable`: Kenso could not add the unsubscribe link or reach the provider. Retry later.\n            \nRequires Inbox edit and the `reply` permission.\n\nRate limit: 10 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `agent_send` feature on your workspace. Until it is on, calls answer 404.","operationId":"threads.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"}},{"name":"Idempotency-Key","in":"header","description":"Required. A unique value, such as a UUID, that makes a retry safe. Send the same key when you retry. Kenso records the key with what the request did, so a repeat of the same request with the same key does not do it twice: the description says what a repeat returns. The same key with a different request answers `422 idempotency_key_reused`. This operation answered `409` for it before 2026-11-17: branch on the code, not the status. Keys are per workspace and at most 200 characters long.","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThreadRequest"}}}},"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/ThreadMessageResponse"}}}},"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"]},"402":{"description":"Payment Required","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":["free_plan_sending_needs_plan","plan_limit_reached"]},"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":["in_progress","invalid_state","outcome_unknown"]},"422":{"description":"Unprocessable Content","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":["guardrail_violation","idempotency_key_reused"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-features":["agent_send"],"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","features":["reply"],"summary":"Inbox edit and the `reply` permission"},"x-ken-rate-limit":{"limit":10,"windowSeconds":60,"per":"api_key","summary":"10 requests a minute per API key; 30 requests a minute and 500 a day per workspace (Free plan: 3 a minute and 50 a day)","quotas":[{"policy":"agentSendEmails","per":"workspace","limits":[{"limit":30,"windowSeconds":60},{"limit":500,"windowSeconds":86400}],"plans":[{"plan":"Free","limits":[{"limit":3,"windowSeconds":60},{"limit":50,"windowSeconds":86400}]}]}]}}},"/v1/threads/{threadId}":{"get":{"tags":["threads"],"summary":"Get a thread","description":"Returns one thread. Read its messages with `GET /v1/threads/{threadId}/messages`.\n            \nAn email thread also carries `scheduledMessages`: the replies and forwards queued on it that have not sent\nyet, a reply that waits for a member's approval included. `POST /v1/scheduled-messages/{scheduledMessageId}/cancel`\nwithdraws one. `accountId` and `accountName` name the account whose touch the thread is, else the\naccount where the thread's contact is a stakeholder. An email thread of an account touch also carries\n`replyTouchId`, the open reply touch that answers it.\n            \nA Facebook thread carries `historyStartsAt` while the account's history is locked.\n            \nA WhatsApp or iMessage thread's `contactId` is its person's newest contact, null when the person has none. An\niMessage thread's `inboxId` is its line's id.\n            \nErrors:\n            \n- `404 not_found`: the id is malformed, or no thread in this workspace has it.\n- `500 internal_error`: Kenso could not load the thread, for example an iMessage thread's ready voice note: try\n  it again.\n            \nRequires Inbox view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"threads.get","parameters":[{"name":"threadId","in":"path","description":"The thread's `thr_` id.","required":true,"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/ThreadResponse"}}}},"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"]},"500":{"description":"Internal Server Error","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":["internal_error"]}},"x-ken-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"patch":{"tags":["threads"],"summary":"Update a thread","description":"Changes a thread's state and keeps every field you leave out. The body is a JSON object with at least one of\nthese fields:\n            \n- `isRead`, `isArchived`, `isSaved`: true or false. Archiving an email thread archives every reply\nin it.\n- `interest`: the label, one of `interested`, `question` (email threads of a workspace with\nreply_question_type; LinkedIn and Instagram threads do not take it), `not_interested`, `negative`,\n`automated`, `unclassified`, `unsubscribe`, `objection`, `wrong_contact`,\n`referral` or `out_of_office`. `not_interested` reads back as `negative`. A LinkedIn or\nInstagram thread does not take `automated`.\n- `reminderAt`: when to remind you, as an ISO 8601 instant. Null clears the reminder.\n- `personId`: links the thread's contact to this person in Accounts and replaces any earlier link. A merged\nperson links as the person it merged into.\n            \nOn an email thread, an `interest` that says a person wrote back (any value but `automated`,\n`out_of_office` and `unclassified`) clears the reply's auto-reply marks. Kenso then treats it as a human\nreply and stops the contact's sequence.\n            \nOn an iMessage thread, `reminderAt` is `400 validation_failed`: iMessage threads take no reminders.\n`interest` needs a text from the person on the thread (`400 validation_failed` otherwise, detail\n`imessage_no_inbound` on `interest`). If a newer text from them arrives before the write, it is\n`400 validation_failed` with detail `imessage_newer_text` on `interest`, and neither the interest nor\nthe other fields change: reload the thread and set `interest` again in a new request (a new\n`Idempotency-Key`, or none: the same key replays this answer for 24 hours). `unsubscribe` opts the number\nout of texts, as the person's own STOP does, so Kenso texts it no more, and a later `interest` does not undo\nit. Kenso checks that the thread exists and holds a text from the person before it writes the opt-out, so a thread\nalready gone when Kenso checks it (`404`) or with no text from the person (`400`, detail\n`imessage_no_inbound`) gets no opt-out. The opt-out is written before the\ninterest, so the interest is never stored without it: a text that arrives, or a delete that lands, while the\nopt-out is written answers `400` (detail `imessage_newer_text`) or `404`, and the opt-out stands. If the opt-out cannot be written, the\nanswer is `500 internal_error` and the interest is not stored, but part of the opt-out may already stand. An\n`interest` set before Kenso classed the person's earlier texts still lets Kenso read those texts for a stop in\nwords: one opts the number out within about a minute, and the interest you set stays.\n            \n`personId` needs the `unified_inbox` feature on the workspace and Accounts edit. Kenso checks the link\nbefore it writes any field and writes the link last, so a refused field leaves no link.\n            \nThe response is the updated thread. It carries `hasDraft` and `draftAuthor`, and leaves out\n`accountId`, `replyTouchId` and `scheduledMessages`.\n            \nA Facebook thread takes `isRead` only. A WhatsApp thread takes no `interest` or `reminderAt`. A\nWhatsApp or iMessage thread does not take `personId`: its person comes from its number.\n            \nErrors:\n            \n- `400 validation_failed`: the body is not an object, has no field, names an unknown field, or holds a value\nof the wrong type or an unknown value; the thread's channel does not take a field (see above); or an iMessage\n`interest` has no text from the person to label (detail `imessage_no_inbound`), or a newer one arrived\nfirst (detail `imessage_newer_text`).\n- `403 forbidden`: the caller is a workspace key and the body sets `interest`. The label reads as set by a\nperson, and a workspace key is not one. Every other field works for it.\n- `403 permission_denied`: the body sets `personId` and the caller lacks Accounts edit.\n- `404 not_found`: the thread is not in this workspace, or the body sets `personId` and the person is\nnot in the workspace, was deleted, or the `unified_inbox` feature is off.\n- `422 unprocessable`: the body sets `personId` and the thread has no contact.\n- `500 internal_error`: Kenso could not update the thread, or read it back after the update, for a fault of\nits own (try it again), for example an iMessage `unsubscribe` that could not write its opt-out (see above).\n            \nRequires Inbox edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"threads.update","parameters":[{"name":"threadId","in":"path","description":"The thread's `thr_` id.","required":true,"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"}},{"name":"Idempotency-Key","in":"header","description":"A unique value, such as a UUID, that makes a retry safe. Send the same key when you retry. For 24 hours, a repeat of the same request with the same key gets the first response again, with the `Idempotent-Replayed: true` header, and Kenso does not run the action twice. The same key with a different request answers `422 idempotency_key_reused`. Keys are per workspace and at most 200 characters long. A repeat sent while the first request is still running can get `503 service_unavailable` with `Retry-After`. Retry it with the same key. Kenso does not store a `5xx` response, so a retry after one runs the action again. It does not store a `408`, a `429` or another `4xx` that carries `Retry-After` either: retry with the same key after that time and Kenso runs the action again.","schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadBody"}}},"required":true},"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/ThreadResponse"}}}},"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","permission_denied"]},"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"]},"422":{"description":"Unprocessable Content","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":["idempotency_key_reused","unprocessable"]},"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"]},"500":{"description":"Internal Server Error","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":["internal_error"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","summary":"Inbox edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/counts":{"get":{"tags":["threads"],"summary":"Count threads by tab","description":"Returns thread counts for the inbox tabs: email and LinkedIn threads, matched Instagram and WhatsApp chats while\nthose channels are on, and iMessage threads while the workspace's `imessage` flag is on. Use it for tab\nbadges and to know when to reload the thread list.\n            \nName the tab with `status`, `folder`, `isArchived` and `isSaved`, the same way\n`GET /v1/threads` takes them. `allCount` is the number of threads that list returns for the tab.\n`accountsCount` and `campaignsCount` split the tab into threads linked to an account and threads from a\ncampaign, and `campaigns` lists every campaign with a thread in the inbox. `toReplyCount`,\n`unreadCount`, `latestMessageAt` and `inboxChangedAt` ignore the tab. An email thread counts once\nhowever many messages it has, and a LinkedIn, Instagram, WhatsApp or iMessage conversation is one thread.\nInstagram, WhatsApp and iMessage threads never count in `campaignsCount` or `campaigns`.\n            \nTo keep a view current, poll this call and reload the list when `inboxChangedAt` changes. It moves when a\nreply arrives, a late one included, and when a reply changes tab, for example when Kenso classifies it.\n            \nWith `groupBy=person` the counts count people instead of threads, each the number of rows\n`GET /v1/threads?groupBy=person` lists for the tab. A person counts under the campaign or account of their\nthread in the tab. On a tab that lists your own sends (`folder=sent` or `folder=all`),\n`allCount`, `accountsCount`, `campaignsCount` and `campaigns[].threadCount` keep counting\nthreads, because that grouped list's total can be capped. `toReplyCount` and `unreadCount` count people\non every tab.\n            \n`facebookUnreadCount` counts Facebook threads with an unread inbound message, and is omitted when Facebook\noutreach is off for the workspace.\n            \nErrors:\n            \n- `400 validation_failed`: `status`, `folder` or `groupBy` is not a known value.\n            \nRequires Inbox view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"threads.counts","parameters":[{"name":"status","in":"query","description":"The inbox tab to count: `to_reply`, `other`, `automated_reply`, `not_interested` or\n`human_reply`. Omit it to count threads of every status.","schema":{"type":"string"}},{"name":"folder","in":"query","description":"Which messages to count: `inbox` (messages received), `sent` (messages sent) or `all` (both).\nDefault `inbox`.","schema":{"type":"string"}},{"name":"isArchived","in":"query","description":"Filters by archive state: `true` counts only archived threads and `false` only threads not archived.\nKenso counts both when it is omitted or when `status=human_reply`.","schema":{"type":"boolean"}},{"name":"isSaved","in":"query","description":"Filters by saved state: `true` counts only saved threads and `false` only threads not saved. Kenso counts\nboth when it is omitted or when `status=human_reply`.","schema":{"type":"boolean"}},{"name":"groupBy","in":"query","description":"Set to `person` to count distinct people instead of threads, one per row of\n`GET /v1/threads?groupBy=person`. Omit it to count threads, and any other value answers\n`400 validation_failed`.","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/ThreadCountsResponse"}}}},"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-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/mark-all-read":{"post":{"tags":["threads"],"summary":"Mark all threads read","description":"Marks every unread thread in the inbox as read and returns how many changed. It covers every unread inbound email\nmessage and every unread LinkedIn conversation in one pass, every unread matched Instagram chat when Instagram is\non for the workspace, every unread WhatsApp chat when WhatsApp is on, every unread allowed Facebook chat when\nFacebook outreach is on, and, while iMessage is on for the workspace, every unread iMessage conversation, in Kenso\nonly. The call takes no body.\n            \nA repeat call is safe and returns `updatedCount: 0`.\n            \nRequires Inbox edit.\n\nRate limit: 480 calls a minute per API key, on top of the workspace limits.","operationId":"threads.mark-all-read","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"}},{"name":"Idempotency-Key","in":"header","description":"A unique value, such as a UUID, that makes a retry safe. Send the same key when you retry. For 24 hours, a repeat of the same request with the same key gets the first response again, with the `Idempotent-Replayed: true` header, and Kenso does not run the action twice. The same key with a different request answers `422 idempotency_key_reused`. Keys are per workspace and at most 200 characters long. A repeat sent while the first request is still running can get `503 service_unavailable` with `Retry-After`. Retry it with the same key. Kenso does not store a `5xx` response, so a retry after one runs the action again. It does not store a `408`, a `429` or another `4xx` that carries `Retry-After` either: retry with the same key after that time and Kenso runs the action again.","schema":{"maxLength":200,"type":"string"}}],"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/MarkAllThreadsReadResponse"}}}},"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"]},"422":{"description":"Unprocessable Content","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":["idempotency_key_reused"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","summary":"Inbox edit"},"x-ken-rate-limit":{"limit":480,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/bulk-update":{"post":{"tags":["threads"],"summary":"Update many threads","description":"Applies the same change to up to 1,000 threads. The body is a JSON object with `ids`, a list of `thr_`\nids, and the fields to change, under the same rules as `PATCH /v1/threads/{threadId}`. `personId` is\nnot allowed here: link people one thread at a time.\n            \nKenso updates each thread on its own, so one failure does not stop the others. The response lists the ids that\nchanged in `succeeded` and the rest in `failed`, each with the error `code` the `PATCH` answers\nfor that thread: `not_found`, `validation_failed`, or `internal_error` when Kenso could not update it\nfor a fault of its own (try it again), and the `PATCH`'s `details` when it has any. A field with a bad\nvalue fails every well-formed id with `validation_failed` (a malformed id stays `not_found`). An iMessage\n`interest` refusal carries detail `imessage_no_inbound` (no text from the person yet) or\n`imessage_newer_text` (a newer text arrived first: reload the thread and set it again). An iMessage thread\nwhose `unsubscribe` opt-out could not be written fails with `internal_error`, and part of that opt-out may\nalready stand, as on `PATCH /v1/threads/{threadId}`. An iMessage thread already gone when Kenso checks it\n(`not_found`) or with no text from the person (`imessage_no_inbound`) fails before its opt-out and gets\nnone; one that a new text (`imessage_newer_text`) or a delete (`not_found`) reaches while its opt-out is\nwritten fails and keeps the opt-out. Retry failed ids in a new request (a new `Idempotency-Key`, or none: the\nsame key replays this answer for 24 hours).\n            \nErrors:\n            \n- `400 validation_failed`: `ids` is missing, empty, longer than 1,000 or holds a value that is not a\nstring, the body has no field to change, or it sets `personId`.\n- `403 forbidden`: the caller is a workspace key and the body sets `interest`, as on a single thread.\n            \nRequires Inbox edit.\n\nRate limit: 480 calls a minute per API key, on top of the workspace limits.","operationId":"threads.bulk-update","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"}},{"name":"Idempotency-Key","in":"header","description":"A unique value, such as a UUID, that makes a retry safe. Send the same key when you retry. For 24 hours, a repeat of the same request with the same key gets the first response again, with the `Idempotent-Replayed: true` header, and Kenso does not run the action twice. The same key with a different request answers `422 idempotency_key_reused`. Keys are per workspace and at most 200 characters long. A repeat sent while the first request is still running can get `503 service_unavailable` with `Retry-After`. Retry it with the same key. Kenso does not store a `5xx` response, so a retry after one runs the action again. It does not store a `408`, a `429` or another `4xx` that carries `Retry-After` either: retry with the same key after that time and Kenso runs the action again.","schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateThreadsBody"}}},"required":true},"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/ThreadBulkResultResponse"}}}},"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"]},"422":{"description":"Unprocessable Content","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":["idempotency_key_reused"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","summary":"Inbox edit"},"x-ken-rate-limit":{"limit":480,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/{threadId}/messages":{"get":{"tags":["threads"],"summary":"List a thread's messages","description":"Returns every message in a thread, oldest first, in one page. Each item carries `kind`: `message` for an\nemail or chat message.\n            \nWith `includeEvents=true` a LinkedIn thread also lists the connection note sent with the invitation\n(`connection_note`, outbound) and the moment the person accepted (`connection_accepted`, inbound, with\nan empty body), in time order. An event comes before a message sent at the same instant. An email thread ignores\n`includeEvents`. When Kenso cannot read the events, it returns the messages alone.\n            \nErrors:\n            \n- `404 not_found`: the id is malformed, or no thread in this workspace has it.\n            \nRequires Inbox view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"threads.list-messages","parameters":[{"name":"threadId","in":"path","description":"The thread's `thr_` id.","required":true,"schema":{"type":"string"}},{"name":"includeEvents","in":"query","description":"True to add a LinkedIn thread's connection events to its messages.","schema":{"type":"boolean"}},{"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/ThreadMessageListResponse"}}}},"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-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"post":{"tags":["threads"],"summary":"Send a reply in a thread","description":"Sends a reply on an email thread, a LinkedIn conversation or an Instagram, Facebook, WhatsApp or iMessage chat.\n`body` is required, except where a channel below lets it be blank: images on Instagram, Facebook or WhatsApp,\na Facebook voice note, or a lone `voiceNoteId` on iMessage. Kenso records each reply\nwith its caller: a person, an API key, or an agent (any caller that sends the header `X-Ken-Actor: agent`).\nKenso records the send only after the email provider or LinkedIn accepts it.\n            \nOn an email thread `senderEmailId`, the inbox that sends, is required. The reply goes to the thread's sender\nunless you name `to`, or set `replyAll: true` to reach the sender, To and Cc without the sending inbox.\n`cc` and `bcc` add recipients. Each recipient is one bare email address. `attachmentIds` takes\n`att_` ids uploaded against the thread's newest message. `contentType` is `html` (the default) or\n`text`. A reply goes out on the thread's subject, so a send ignores `subject` (an iMessage thread\nrefuses it).\n            \nKenso queues an email reply for an undo window of `delaySeconds`, 60 (the default) or 300 seconds. The\n`201` response carries the queued reply's `scheduledMessageId`, and\n`POST /v1/scheduled-messages/{scheduledMessageId}/cancel` stops it until the window ends. A pause or block\nthat starts during the window refuses the reply at send time, and its scheduled message ends `failed`. With\n`archiveAfterSend: true` Kenso archives the thread once the reply sends.\n            \nAn email reply to a contact who is do-not-contact, blocklisted or unsubscribed returns `409 invalid_state`\nwith a `confirmSuppressed` detail whose code is the reason. Kenso sends it only when you repeat the request\nwith `confirmSuppressed: true`, and the reply then carries a `suppressed_contact_overridden` warning.\n            \nSome email replies wait for approval and return `202` instead of sending:\n            \n- When the workspace requires external approval for replies, the response has\n`status: held_for_client_approval` and the `clientApprovalItemId` that holds the reply.\n- A reply an agent or API key sends from its own member's mailbox returns the scheduled message with\n`status: awaiting_approval` and `approverMemberId`. It waits in that member's `GET /v1/approvals`\nuntil they approve it in person. From another member's own mailbox, or with the `accounts` feature off, it\nis `403 forbidden`.\n- A reply a teammate writes in person from the own inbox of a member with the Client role, while the\n`accounts_send` feature is on, waits the same way in that member's `GET /v1/approvals`.\n            \nA waiting reply with `archiveAfterSend` archives the thread only when the approved reply sends.\n            \nAn agent's or API key's reply from an inbox a member paused or Kenso blocked from sending returns\n`409 invalid_state` with detail code `inbox_paused` or `inbox_send_blocked` and a `fix`. A\nblock also carries `nextAllowedAt`, when it ends, and a `Retry-After` header. A pause has no known end.\n            \nAn email reply takes an optional `Idempotency-Key` of at most 200 characters, unique in the workspace. The\nkey is bound to the thread, the inbox and the body, and to `to`, `cc`, `bcc`, `replyAll`,\n`contentType` and `attachmentIds` when you send them. A retry returns the reply the key queued, or the\n`202` it was held with, and queues nothing. A refused reply frees its key.\n            \nOn a LinkedIn thread Kenso sends plain text at once from the LinkedIn account that holds the conversation, and\nignores `delaySeconds`. A LinkedIn reply that names an email-only field (`to`, `cc`, `bcc`,\n`replyAll`, `attachmentIds` or `contentType`) gets `400 validation_failed` on that field and\nsends nothing. Kenso always refuses a LinkedIn reply to a suppressed contact. A LinkedIn `Idempotency-Key` is\nbound to its thread and text. Without a key, the same text sent again in the thread more than 5 minutes later\nsends again.\n            \nA LinkedIn reply an agent or API key sends through an account another member connected waits for that member. The\n`202` response has `status: awaiting_approval`, `channel: linkedin`, the `approvalId` (type\n`reply.linkedin`) and `approverMemberId`. It sends once that member approves it in person in\n`GET /v1/approvals`. A retry with the same key, or the same text without one, returns the same waiting reply.\nWith the `accounts` feature off for that member, or on an account no member connected, it is\n`403 forbidden`. A person's own reply in the Kenso app, and the account owner's own agent or API key, send at\nonce.\n            \nOn an Instagram thread Kenso sends at once from the chat's account: text of at most 1,000 characters and up to 3\nimages uploaded with `purpose=instagram` (their `att_` ids in `attachmentIds`; then `body` may\nbe blank). It refuses email-only fields, `senderEmailId`, `imageIds` and `voiceNoteId` with\n`400`, a suppressed person, and an agent's or API key's reply through an account another member connected\n(`403 forbidden`). A paused, resting, limited or disconnected account answers `409 invalid_state`, with\n`nextAllowedAt` and `Retry-After` when known. Its `503` may mean the message went out: retry with\nthe same body, images and `Idempotency-Key` (or again none), never under a new key.\n            \nA Facebook reply sends `body` (optional when it has images or a voice note, at most 2,000 characters), then\neach of `imageIds` as its own message, then `voiceNoteId`, through the Facebook account that holds the\nchat. It is recorded only after Facebook confirms each part. A part that fails stops the rest:\n`409 invalid_state` says how many were sent. When Kenso cannot tell whether a part was sent, the reply is\n`503 service_unavailable` and is never sent again under the same `Idempotency-Key`: read the thread\nfirst. An agent or API key replies only through a Facebook account its own member connected (else `403`).\nEmail-only fields are `400` on a Facebook thread.\n            \nA WhatsApp reply sends at once from the chat's account: text of at most 4,096 characters, up to 6\n`mediaIds` (then `body` may be blank), or a voice note of `body` with `voiceProvider` and\n`voiceId`. It follows the LinkedIn rules above for email-only fields, suppression, keys and an agent's reply\nthrough another member's account (approval type `reply.whatsapp`). WhatsApp's send limits answer\n`409 invalid_state` with `nextAllowedAt` and `Retry-After`.\n            \nOn an iMessage thread (while the `imessage` flag is on) a member's reply takes `body` (at most 4,096\ncharacters), with up to 10 `mediaIds` if you want images, or a lone `voiceNoteId`, and sends at once:\n`201` once the send is confirmed. Images never go without a text: `mediaIds` with a blank `body` is\n`400 validation_failed` on `body`. Setting `subject`, `to`, `cc`, `bcc`,\n`replyAll`, `attachmentIds`, `contentType`, `voiceProvider`, `voiceId` or\n`imageIds` there is `400 validation_failed` on that field, and nothing is sent. A longer `body`\n(detail `imessage_text_too_long`; nothing is sent), a text before the person replied that holds a link, an\nemail address, a phone number or a money amount (detail `first_message_content`), or an unusable image or\nvoice note, is `400 validation_failed`. A `body` that still holds a\ntemplate key nobody filled in is `422 unfilled_template_key`, with the key in the detail's `key` and the\nmarker as written in `marker`. In a member's own text only a brace key counts (`{first_name}`,\n`{{company}}`, spintax), so square brackets are ordinary text; in an agent's or API key's text\na square-bracket key such as `[company]` counts too. A line that cannot send now holds the text:\n`409 invalid_state` with the reason as detail code, `nextAllowedAt` and `Retry-After`, so send it\nagain after that time. A refusal is `409 invalid_state` with the reason as detail code, no `nextAllowedAt`\nand no `Retry-After`, and its `fix` says what must change: media before the person replied\n(`imessage_media_requires_reply`) or on an SMS thread (`imessage_sms_thread`), `recipient_must_reply`,\n`phone_opt_out` (a STOP, or the person's opt-out of texts), `do_not_call` (a provider the workspace's own key asked flagged the person do not call, and the person\nhas not written in this thread or the text is an agent's or API key's: a member may answer a person who wrote),\n`suppressed:<reason>` (blocklist,\ndo-not-contact, unsubscribed; never overridable), `provider_rejected:IMESSAGE_SEND_REFUSED`,\n`imessage_line_owner_left` and `imessage_line_gone` (the thread's line was released, failed or never\nactivated, or the thread is gone, so nothing\ngoes on this thread again, and a new line cannot carry it). An agent or API key may text only a person who\nengaged first (`409`, detail `imessage_not_engaged`), and never one whose no stands, even after they texted\nthis thread: `409` with detail `person_refused` while nothing since their no takes it back (a reply classed\nas no refusal, an accepted connection or a booked meeting; a text with no class never does), and `503` with\ndetail `imessage_reply_unclassified` while a message of theirs after it still waits for its class (try again in\na few minutes). Neither saves a touch or sends anything; a member may still send the text. Its text always waits for approval, through the line\nowner's own credential too: it is saved as an iMessage touch pinned to this thread, so it goes only from this thread's\nline to this thread's number, and answered `202` with `status` `awaiting_approval`, `channel`\n`imessage`, the `touch_` `approvalId`, `approverMemberId` and `approverName` (that member's\nfirst name). Only a person approves it: an agent or API key gets `403`, detail\n`approval_requires_human`. When this thread's line can no longer send, the agent's text is\n`409 invalid_state` with detail `imessage_line_gone` (the line was released, failed or never activated, or\nits thread is gone), `imessage_line_down` or\n`imessage_line_owner_left`; a paused line still takes it, and it waits there. An agent's voice note, or a person\non no live account, is `403 forbidden` with detail `imessage_agent_voice_note` (on `voiceNoteId`) or\n`imessage_person_on_no_account` (on `threadId`), unless an earlier check refuses the voice note first\n(`409` `imessage_media_requires_reply` or `imessage_sms_thread`, `400`\n`imessage_voice_note_alone` or `imessage_voice_note_unavailable`). `409 outcome_unknown`\nmeans Kenso could not tell whether the text went out: never send it again under a new key. When it carries\n`nextAllowedAt` and `Retry-After`, send the same request with the same `Idempotency-Key` after that\ntime: Kenso reads the thread and answers `201` when the text is there, or `503` with detail\n`imessage_reply_not_sent` when it never went (the key is free again: send it under the same key or a new\none). When Kenso cannot read the thread yet, it answers `409 outcome_unknown` again with a later\n`nextAllowedAt`. When the thread or its line is gone, it answers `404` or `409 invalid_state` with\ndetail `imessage_line_gone`, frees the key, and nothing more goes. While iMessage sending is paused, that\nretry answers `503` with detail `imessage_first_try_unknown` instead: it sent nothing, but the first try\nmay have gone, so read the thread or retry later under the same key. Any other `503` means nothing\nwent. An iMessage `Idempotency-Key` never sends twice:\na retry with it answers the same `201` or `202`. `mediaIds` and `voiceNoteId` on any other\nthread are `400 validation_failed`.\n            \nErrors:\n            \n- `400 validation_failed`: `body` is missing where the channel needs one (an iMessage reply needs one\nunless it is a lone `voiceNoteId`), `delaySeconds` is not 60 or 300,\n`senderEmailId` is missing on an email thread, a recipient is not an email address, `contentType` is not\n`html` or `text`, `attachmentIds` names a file of another message, a LinkedIn or iMessage reply\nnames a field its channel does not take, the `Idempotency-Key` is longer than 200 characters, or the provider\nrejected the message.\n- `403 forbidden`: the caller may not send from this inbox or LinkedIn account, or an agent or API key sent a\nvoice note on an iMessage thread (detail `imessage_agent_voice_note`) or texted a person on no live account\n(detail `imessage_person_on_no_account`).\n- `404 not_found`: the id is malformed, or no thread in this workspace has it.\n- `409 invalid_state`: the contact is suppressed, the sending inbox is disconnected, paused or blocked, the\nLinkedIn account reached its daily limit, an iMessage line cannot send now (with `nextAllowedAt`) or refused the\ntext (no retry time, see above), or the thread's line was released, failed or never activated\n(`imessage_line_gone`), or an agent's text has\na thread line that is down or whose owner can't send from it (`imessage_line_down`, `imessage_line_owner_left`),\nor an agent's text goes to a person whose no stands (`person_refused`).\n- `409 in_progress`: an email reply under this key is still being queued. Retry after\n`nextAllowedAt`, also sent as `Retry-After`. On an iMessage thread, a reply under this key is still being\nsent by another request, which owns the send: nothing more goes, so read the thread in a moment.\n- `409 outcome_unknown`: Kenso cannot tell whether the email reply under this key was queued, and never\nqueues it again. Read the thread before you reply under a new key. On an iMessage thread it may carry\n`nextAllowedAt` and `Retry-After`: retry the same request with the same key after that time.\n- `409 reply_not_sent`: the email reply under this key failed or was cancelled and never went out. Send it\nagain under a new key if you still want it.\n- `422 unfilled_template_key`: an iMessage text still holds a template key, named in the detail's `key` and\nquoted as written in `marker`. Fill it in or take it out.\n- `422 idempotency_key_reused`: the key was used for another request or another thread. This operation\nanswered `409` for it before 2026-11-17.\n- `503 service_unavailable`: the provider could not take the message, or Kenso could not save the reply for\napproval. Retry later. On an iMessage thread, detail `imessage_unavailable` means iMessage cannot send right\nnow (Kenso could not check the line's new-conversation lock, or iMessage is unavailable for now): nothing was sent,\ntry again later. Detail `imessage_reply_unclassified` on an agent's text: a message of theirs after their no\nwaits for its class; nothing was saved, try again in a few minutes. Detail `imessage_reply_not_sent` answers a\nretry under the key of an unsure text that Kenso found never went out: the key is free again, so send it again\nunder the same key or a new one. Detail `imessage_first_try_unknown` answers a retry under the key of an\nunsure text while iMessage sending is paused: this retry sent nothing, but the first try may have gone out. While\niMessage sending is paused, a key whose first try is still running answers this `503` too (not\n`409 in_progress`), and a key used for another reply answers the plain `503` (not\n`422 idempotency_key_reused`).\n            \nRequires Inbox edit and the `reply` permission.\n\nRate limit: 10 calls a minute per API key, on top of the workspace limits.","operationId":"threads.create-message","parameters":[{"name":"threadId","in":"path","description":"The thread's `thr_` id.","required":true,"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"}},{"name":"Idempotency-Key","in":"header","description":"A unique value, such as a UUID, that makes a retry safe. Send the same key when you retry. Kenso records the key with what the request did, so a repeat of the same request with the same key does not do it twice: the description says what a repeat returns. The same key with a different request answers `422 idempotency_key_reused`. This operation answered `409` for it before 2026-11-17: branch on the code, not the status. Keys are per workspace and at most 200 characters long.","schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThreadMessageRequest"}}}},"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/ThreadMessageResponse"}}}},"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":{"oneOf":[{"$ref":"#/components/schemas/ThreadMessageHeldResponse"},{"$ref":"#/components/schemas/ScheduledMessageResponse"},{"$ref":"#/components/schemas/ThreadMessageAwaitingApprovalResponse"}]}}}},"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":["in_progress","invalid_state","outcome_unknown","reply_not_sent"]},"422":{"description":"Unprocessable Content","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":["idempotency_key_reused","unfilled_template_key"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","features":["reply"],"summary":"Inbox edit and the `reply` permission"},"x-ken-rate-limit":{"limit":10,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/{threadId}/draft":{"get":{"tags":["threads"],"summary":"Get a thread's draft","description":"Returns the reply draft saved on a thread. `authorSource` says who last wrote it: `user` for a person in\nthe Kenso app, `agent` for an agent or API key. When an agent wrote the reply in the contact's language, the\ndraft also carries `mirror`, the same reply in the reader's language.\n            \nA Facebook or iMessage thread has no draft: `404`.\n            \nErrors:\n            \n- `404 not_found`: the id is malformed, no thread in this workspace has it, or the thread has no draft.\n            \nRequires Inbox view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"threads.get-draft","parameters":[{"name":"threadId","in":"path","description":"The thread's `thr_` id.","required":true,"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/ThreadDraftResponse"}}}},"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-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"put":{"tags":["threads"],"summary":"Replace a thread's draft","description":"Saves the reply draft on a thread in place of the one there. Send `body` and, on an email thread, an\noptional `subject`. An empty or missing `body` deletes the draft and returns `204` with no body.\n            \nOnly a person signed in to the Kenso app writes as the draft's author, `user`. An agent (any caller that\nsends the header `X-Ken-Actor: agent`) or an API key writes as `agent`, and never overwrites or deletes\na person's draft: the response is then the person's draft, unchanged.\n            \nOn an email thread, a person who saves a reply Ken wrote into their composer sends `authorSource`\n`agent`, and the model that wrote it in the header `X-Ken-Generator`. The draft is theirs, as their own\nsave is (`authorSource` stays `user`, so no agent write replaces it), and it records the text as Ken's,\nso their send or discard of it is measured against that text.\n            \nOn an email thread, saving or clearing a draft also stops any reply or follow-up that Ken holds for the thread, so\nKen does not send on top of it.\n            \nA Facebook thread has no draft: `404`. An iMessage thread has none either: writing one, an empty\n`body` included, is `400 validation_failed` on `threadId`.\n            \nErrors:\n            \n- `400 validation_failed` on `threadId`: an iMessage thread has no drafts.\n- `404 not_found`: the id is malformed, or no thread in this workspace has it.\n            \nRequires Inbox edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"threads.replace-draft","parameters":[{"name":"threadId","in":"path","description":"The thread's `thr_` id.","required":true,"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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertThreadDraftRequest"}}}},"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/ThreadDraftResponse"}}}},"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-permission":{"kind":"page","page":"inbox","access":"edit","summary":"Inbox edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}},"delete":{"tags":["threads"],"summary":"Delete a thread's draft","description":"Deletes the reply draft saved on a thread. Returns `204` with no body, also when the thread has no draft.\nUnlike an empty `PUT /v1/threads/{threadId}/draft`, this deletes a person's draft whoever calls.\n            \nA Facebook thread has no draft: `404`. An iMessage thread has none either, so it answers `204`.\n            \nErrors:\n            \n- `404 not_found`: the id is malformed, or no thread in this workspace has it.\n            \nRequires Inbox edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"threads.delete-draft","parameters":[{"name":"threadId","in":"path","description":"The thread's `thr_` id.","required":true,"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":{"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"]},"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-permission":{"kind":"page","page":"inbox","access":"edit","summary":"Inbox edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/{threadId}/images":{"post":{"tags":["threads"],"summary":"Upload an image for a Facebook reply.","description":"Facebook threads only (any other thread is 404). Multipart field `file`: a jpg, png or webp image up to 8 MB,\nchecked by its content. A thread holds at most 4 images until the next reply sends them; an image not sent within\n24 hours is dropped. Pass the returned `id` in `imageIds` on `POST /v1/threads/{threadId}/messages`.\nRequires Inbox edit and the `reply` permission.\n\nRate limit: 30 calls a minute per API key, on top of the workspace limits.","operationId":"threads.create-image","parameters":[{"name":"threadId","in":"path","description":"The Facebook thread's `thr_` id.","required":true,"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"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The image, as a multipart file part.","format":"binary"}}},"encoding":{"file":{"style":"form"}}}}},"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/ThreadImageResponse"}}}},"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-permission":{"kind":"page","page":"inbox","access":"edit","features":["reply"],"summary":"Inbox edit and the `reply` permission"},"x-ken-rate-limit":{"limit":30,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/{threadId}/forward":{"post":{"tags":["threads"],"summary":"Forward an email thread","description":"Forwards an email thread's newest message to new recipients. Email threads only. `body` is required, and\n`to` is required unless `replyAll` is true. Each recipient is one bare email address.\n            \n`senderEmailId`, the inbox that sends, is required unless `replyAll` is true. Kenso queues the forward\nfor an undo window of `delaySeconds`, 60 (the default) or 300 seconds, and returns `200` with the\nscheduled message. `POST /v1/scheduled-messages/{scheduledMessageId}/cancel` stops it until the window ends.\n`attachmentIds` takes `att_` ids uploaded against the thread's newest message. With\n`archiveAfterSend: true` Kenso archives the thread once the forward sends.\n            \nA forward that goes back into the thread is refused when the contact is suppressed or when the workspace holds\nreplies for external approval. A forward goes back into the thread when it uses `replyAll` without\n`to`, or names the contact or another participant as a recipient. No setting overrides this refusal: send a\nreply instead.\n            \nA forward an agent or API key sends from its own member's mailbox does not send yet. It returns `202` with\nthe scheduled message in `status: awaiting_approval` and `approverMemberId`, and waits in that member's\n`GET /v1/approvals` until they approve it in person. From another member's own mailbox, or with the\n`accounts` feature off, it is `403 forbidden`.\n            \nThe built-in Client role has no `export` permission, so its members can reply but not forward.\n            \nErrors:\n            \n- `400 validation_failed`: `body` or a required field is missing, a recipient is not an email address,\n`delaySeconds` is not 60 or 300, `contentType` is not `html` or `text`,\n`attachmentIds` names a file of another message, the thread is a LinkedIn thread, or the provider rejected\nthe forward.\n- `403 forbidden`: the caller may not send from this inbox.\n- `404 not_found`: the id is malformed, or no thread in this workspace has it.\n- `409 invalid_state`: the sending inbox is disconnected, or the forward goes back into the thread while the\ncontact is suppressed or replies need external approval. The detail code is the suppression reason or\n`client_approval_required`.\n- `503 service_unavailable`: Kenso could not queue the forward. Retry later.\n            \nRequires Inbox edit and the `reply` and `export` permissions.\n\nRate limit: 10 calls a minute per API key, on top of the workspace limits.","operationId":"threads.forward","parameters":[{"name":"threadId","in":"path","description":"The thread's `thr_` id.","required":true,"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"}},{"name":"Idempotency-Key","in":"header","description":"A unique value, such as a UUID, that makes a retry safe. Send the same key when you retry. For 24 hours, a repeat of the same request with the same key gets the first response again, with the `Idempotent-Replayed: true` header, and Kenso does not run the action twice. The same key with a different request answers `422 idempotency_key_reused`. Keys are per workspace and at most 200 characters long. A repeat sent while the first request is still running can get `503 service_unavailable` with `Retry-After`. Retry it with the same key. Kenso does not store a `4xx` or `5xx` response, so a retry after one runs the action again.","schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardThreadRequest"}}}},"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/ScheduledMessageResponse"}}}},"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/ScheduledMessageResponse"}}}},"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":["invalid_state"]},"422":{"description":"Unprocessable Content","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":["idempotency_key_reused"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","features":["reply","export"],"summary":"Inbox edit and the `reply` and `export` permissions"},"x-ken-rate-limit":{"limit":10,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/{threadId}/messages/{messageId}/reaction":{"put":{"tags":["threads"],"summary":"React to a received iMessage text.","description":"A member's tapback on a received iMessage text. `reaction` is love, like, dislike, laugh,\nemphasize, question or one emoji; null removes yours; anything else is `400 validation_failed` with detail\n`invalid` on `reaction`. Kenso never reacts on its own. Kenso sends the tapback first\nand records it after, so a refused or failed one leaves nothing behind. Only a text the person sent can take one\n(`400 validation_failed`, detail `imessage_reaction_unavailable` on `messageId` otherwise). A thread\non another channel is `400` on `threadId`; a message id of another thread is `404`. A number that\nopted out of texts (a STOP), or a person who opted out of texts, is\n`409 invalid_state` with detail code `phone_opt_out` (never `suppressed:phone_opt_out`); a\nblocklisted, do-not-contact or unsubscribed person is `suppressed:<reason>`, for adding and removing\nalike. A person a provider the\nworkspace's own key asked flagged do not call is `409 invalid_state` with detail code `do_not_call` only\nfor an agent's or API key's tapback: a member's tapback answers a text the person sent, so it goes. A line whose owner\ncan't send from it anymore is `409 invalid_state` with detail code `imessage_line_owner_left` until an\nadmin gives the line a new owner in Delivery. A thread whose line is gone (released, failed or never activated) is\n`409 invalid_state` with detail\ncode `imessage_line_gone`: nothing goes on that thread again. A line that cannot react now is held as a reply\nis: `409 invalid_state` with the line's state as detail code (`imessage_line_down` when the line is down,\n`imessage_line_paused`, `imessage_line_unpaid`, `connect_imessage`), the detail's\n`nextAllowedAt` and `Retry-After`. An agent or API key, the line owner's own included, follows the agent\nrules: a line a member paused holds its tapback (`imessage_line_paused`) until a member resumes it, and on an SMS\nthread (`imessage.isSmsThread`), where a tapback arrives as a text, its tapback and its removal are\n`409 invalid_state` with detail code `imessage_sms_thread` and nothing is sent: a member sends it. A\n`409` with `nextAllowedAt` is worth retrying after that time, one without it is a refusal.\n`409 outcome_unknown` means Kenso got no answer and the tapback may have gone: read the thread before sending\nit again. A retry under the same `Idempotency-Key` replays that answer.\n`503 service_unavailable` means nothing was sent and a retry is safe; its detail code\n`imessage_unavailable` means iMessage cannot send for now, so try again later.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `imessage` feature on your workspace. Until it is on, calls answer 404.","operationId":"threads.react-message","parameters":[{"name":"threadId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"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"}},{"name":"Idempotency-Key","in":"header","description":"A unique value, such as a UUID, that makes a retry safe. Send the same key when you retry. For 24 hours, a repeat of the same request with the same key gets the first response again, with the `Idempotent-Replayed: true` header, and Kenso does not run the action twice. The same key with a different request answers `422 idempotency_key_reused`. Keys are per workspace and at most 200 characters long. A repeat sent while the first request is still running can get `503 service_unavailable` with `Retry-After`. Retry it with the same key. Kenso does not store a `5xx` response, so a retry after one runs the action again. It does not store a `408`, a `429` or another `4xx` that carries `Retry-After` either: retry with the same key after that time and Kenso runs the action again.","schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactThreadMessageRequest"}}}},"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/ThreadMessageReactionResponse"}}}},"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"]},"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":["invalid_state","outcome_unknown"]},"422":{"description":"Unprocessable Content","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":["idempotency_key_reused"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-features":["imessage"],"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","features":["reply"],"summary":"Inbox edit and the `reply` permission"},"x-ken-rate-limit":{"limit":240,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/{threadId}/messages/{messageId}/attachments/{index}":{"get":{"tags":["threads"],"summary":"Download a received iMessage attachment.","description":"The bytes of the attachment at `index` (0-based) on a message the person sent, in the order\n`imessage.attachments` lists them; each attachment's `url` is this route. Served with its stored content\ntype (else `application/octet-stream`), images inline, others as a file, with\n`Cache-Control: private, max-age=3600`. A malformed id, another workspace's thread, an index with no attachment\nor a link Kenso will not fetch is `404 not_found`; a file over 10,000,000 bytes is\n`422 attachment_too_large`; the file's host failing is `503 service_unavailable` or\n`504 upstream_timeout`. Requires Inbox view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `imessage` feature on your workspace. Until it is on, calls answer 404.","operationId":"threads.get-message-attachment","parameters":[{"name":"threadId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"index","in":"path","required":true,"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/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"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"]},"422":{"description":"Unprocessable Content","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":["attachment_too_large"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]},"504":{"description":"Gateway Timeout","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":["upstream_timeout"]}},"x-ken-features":["imessage"],"x-ken-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/threads/messages":{"get":{"tags":["threads"],"summary":"List the messages of several threads","description":"Returns the messages of up to 50 email threads in one call. `threadIds` is a comma-separated list of\n`thr_` ids. `data.threads` has one item per thread Kenso read, in the order you sent the ids, each with\nits `threadId` and its `messages`, oldest first. An id sent twice is answered once.\n            \nEach message reads as `GET /v1/threads/{threadId}/messages` lists it, with two differences. `htmlBody` is\nleft out unless you send `includeHtml=true`. `body` is the message's text part, or its HTML when it has\nno text part, and an inbound message's `extractedText` is its reply as plain text. `sentBy` and\n`agentJobId` are never set here: read one thread to see which emails Ken sent on its own.\n            \nAn id Kenso did not read is listed in `data.failed` with its error, and the rest of the call still succeeds:\n            \n- `not_found`: the id is malformed, or no thread in this workspace has it.\n- `validation_failed` with detail code `channel_not_supported`: the thread is a LinkedIn, Instagram,\nFacebook, WhatsApp or iMessage thread. Read it with `GET /v1/threads/{threadId}/messages`.\n            \nErrors:\n            \n- `400 validation_failed`: `threadIds` is missing or empty, or names more than 50 threads.\n            \nRequires Inbox view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"threads.batch-messages","parameters":[{"name":"threadIds","in":"query","description":"Up to 50 comma-separated `thr_` ids of email threads.","schema":{"type":"string"}},{"name":"includeHtml","in":"query","description":"True to add each message's `htmlBody`. Left out by default.","schema":{"type":"boolean"}},{"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/ThreadMessagesBatchResponse"}}}},"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-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox 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."},"BulkUpdateThreadsBody":{"required":["ids"],"type":"object","properties":{"isRead":{"type":"boolean","description":"True marks the thread read, false unread. Null is refused."},"isArchived":{"type":"boolean","description":"True archives the thread, false moves it back to the inbox. Archiving an email thread archives every reply in it.\nNull is refused."},"isSaved":{"type":"boolean","description":"True saves the thread, false takes it out of the saved threads. Null is refused."},"interest":{"type":"string","description":"The label: `interested`, `not_interested`, `negative`, `automated`, `unclassified`,\n`unsubscribe`, `objection`, `wrong_contact`, `referral` or `out_of_office`.\n`not_interested` reads back as `negative`, and a LinkedIn thread does not take `automated`. On an\nemail thread, any value but `automated`, `out_of_office` and `unclassified` marks the reply as\nwritten by a person and stops the contact's sequence. Null is refused."},"reminderAt":{"type":"string","description":"When to remind you, as an ISO 8601 instant. Null clears the reminder.","format":"date-time","nullable":true},"ids":{"type":"array","items":{"type":"string"},"description":"Required. From 1 to 1,000 `thr_` thread ids."}},"additionalProperties":false,"description":"The threads to update and the change to make on each: at least one field besides `ids`, under the rules of\n`PATCH /v1/threads/{threadId}`. `personId` is refused here: link people one thread at a time.","example":{"ids":["thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20","thr_ZW1haWw6NDAyMzE3LjFAZXhhbXBsZS5jb20"],"isRead":true,"isArchived":true,"isSaved":false,"interest":"out_of_office"}},"CreateThreadMessageRequest":{"type":"object","properties":{"body":{"type":"string","description":"The reply text: HTML on an email thread unless `contentType` is `text`, plain text on any other thread.\nRequired, except with images on an Instagram, Facebook or WhatsApp thread, a Facebook voice note, or a lone\niMessage `voiceNoteId`.","nullable":true},"subject":{"type":"string","description":"Drafts only. A reply goes out on the thread's own subject, so a send ignores this field, except on an iMessage\nthread, which refuses it with `400 validation_failed`. Set a draft's subject with\n`PUT /v1/threads/{threadId}/draft`.","nullable":true},"senderEmailId":{"type":"integer","description":"Email only, and required there: the id of the inbox that sends the reply.","format":"int32","nullable":true},"delaySeconds":{"type":"integer","description":"Email only: the undo window before the reply sends, 60 or 300 seconds. Omitted, it is 60. Cancel the queued\nreply with `POST /v1/scheduled-messages/{scheduledMessageId}/cancel` and the response's\n`scheduledMessageId`. A LinkedIn reply sends at once and ignores it.","format":"int32","nullable":true},"confirmSuppressed":{"type":"boolean","description":"Email only: send even though the contact is do-not-contact, blocklisted or unsubscribed. Set it only after a\nperson confirmed a `409 invalid_state` that names a suppressed contact."},"archiveAfterSend":{"type":"boolean","description":"Email only: archive the thread once the reply sends. A reply that waits for approval archives the thread when\nthe approved reply sends, never while it waits, and a reply that never sends leaves the thread as it was."},"to":{"type":"array","items":{"$ref":"#/components/schemas/ThreadAddressRequest"},"description":"Email only: who the reply goes to, each one bare email address. Omitted, the reply goes to the thread's sender,\nor to everyone on the thread with `replyAll`. A LinkedIn thread refuses it.","nullable":true},"cc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadAddressRequest"},"description":"Email only: Cc recipients, each one bare email address. A LinkedIn thread refuses it.","nullable":true},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadAddressRequest"},"description":"Email only: Bcc recipients, each one bare email address. A LinkedIn thread refuses it.","nullable":true},"replyAll":{"type":"boolean","description":"Email only: without `to`, reply to the thread's sender, To and Cc, minus the sending inbox. A LinkedIn\nthread refuses it."},"attachmentIds":{"type":"array","items":{"type":"string"},"description":"Email: `att_` ids of files uploaded with `POST /v1/attachments` against the thread's newest message.\nInstagram: up to 3 `att_` ids of images uploaded with `purpose=instagram`. A LinkedIn thread refuses it.","nullable":true},"contentType":{"type":"string","description":"Email only: `html` (the default) or `text`. A LinkedIn thread refuses it.","nullable":true},"imageIds":{"type":"array","items":{"type":"string"},"description":"Facebook only: images uploaded with POST /v1/threads/{threadId}/images, sent after the text, one message each. At\nmost 4. Any other thread refuses it with `400 validation_failed`; an Instagram reply sends its images in\n`attachmentIds`.","nullable":true},"voiceNoteId":{"type":"integer","description":"Facebook and iMessage threads only. On Facebook, a ready voice note Kenso made for the thread, sent last. On\niMessage, a ready voice note made for this person\nwith `POST /v1/voice-notes`. It goes alone, with no body or images. A member's reply only: from an agent or an\nAPI key it is `403 forbidden` (`imessage_agent_voice_note`); they put the note on the person's iMessage\ntouch instead, which a member approves. Any other thread refuses it with `400 validation_failed`.","format":"int64","nullable":true},"mediaIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"WhatsApp and iMessage threads only. On WhatsApp, up to 6 distinct `message_media` image ids to send with the\ntext; with images, `body` may be blank. On iMessage, the `mediaId`s of images uploaded with\n`POST /v1/imessage-media`, at most 10, sent with a `body` (never alone: a blank `body` is\n`400 validation_failed` on `body`), only after the person replied and never on an SMS thread.","nullable":true},"voiceProvider":{"type":"string","description":"WhatsApp threads only: `deepgram` or `elevenlabs`. With `voiceId`, the reply goes out as a voice\nnote that speaks `body` (at most 900 characters) instead of text.","nullable":true},"voiceId":{"type":"string","description":"WhatsApp threads only: the voice of the voice note, at most 200 characters. Requires `voiceProvider`.","nullable":true}},"additionalProperties":false,"description":"A reply in a thread.","example":{"body":"<p>Hi Amanda,</p><p>Thursday works. Does 2pm Central suit you? I will send an invite.</p><p>Alex</p>","senderEmailId":5530,"delaySeconds":60,"confirmSuppressed":false,"archiveAfterSend":false,"replyAll":false,"contentType":"html"}},"CreateThreadRecipient":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"Required. One plain email address, such as `jane@acme.com`."},"name":{"type":"string","description":"The person's name. Optional.","nullable":true}},"additionalProperties":false,"description":"The person a new thread's email goes to."},"CreateThreadRequest":{"required":["senderInboxId","to","subject","body"],"type":"object","properties":{"senderInboxId":{"type":"integer","description":"Required. The id of one of the workspace's shared cold inboxes, from `GET /v1/inboxes`. A member's own\nmailbox is refused.","format":"int64"},"to":{"allOf":[{"$ref":"#/components/schemas/CreateThreadRecipient"}],"description":"Required. The one person the email goes to."},"subject":{"type":"string","description":"Required. The email's subject."},"body":{"type":"string","description":"Required. The email body as HTML."},"overrideContactLimits":{"type":"boolean","description":"true sends this email past a contact limit that refuses it (the send window, an account with an open deal),\nfor an agent in a workspace with agent_contact_limit_override on; otherwise, and for an API\nkey, the limit's 422 guardrail_violation stands. Default false.","nullable":true}},"additionalProperties":false,"description":"A new email to one person, which starts a thread.","example":{"senderInboxId":5530,"to":{"name":"Priya Shah","address":"priya.shah@northwind.example.com"},"subject":"Amanda Chen suggested I reach out","body":"<p>Hi Priya,</p><p>Amanda mentioned you run onboarding for new engineers. Could I send you a 2-minute video on how we cut setup time?</p><p>Alex</p>"}},"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`."},"ForwardThreadRequest":{"required":["body"],"type":"object","properties":{"body":{"type":"string","description":"Required. Your note above the forwarded message: HTML unless `contentType` is `text`."},"senderEmailId":{"type":"integer","description":"The id of the inbox that sends the forward. Required unless `replyAll` is true, when Kenso picks the inbox\nfrom the thread.","format":"int32","nullable":true},"contentType":{"type":"string","description":"The body's format: `html` (the default) or `text`.","nullable":true},"replyAll":{"type":"boolean","description":"Without `to`, true sends the forward to the thread's sender, To and Cc, minus the sending inbox. A forward\nthat goes back into the thread is refused when the contact is suppressed or replies need external approval."},"injectPreviousEmailBody":{"type":"boolean","description":"Quote the forwarded message under your note. Omitted or true quotes it, false leaves it out.","nullable":true},"replyTemplateId":{"type":"integer","description":"The id of the reply template the note came from. Kenso stores it with the forward, and it does not change what\nis sent.","format":"int32","nullable":true},"useDedicatedIps":{"type":"boolean","description":"Kenso stores it with the forward, and it does not change how the forward is sent."},"to":{"type":"array","items":{"$ref":"#/components/schemas/ThreadAddressRequest"},"description":"Who the forward goes to, each one bare email address. Required unless `replyAll` is true.","nullable":true},"cc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadAddressRequest"},"description":"Cc recipients, each one bare email address.","nullable":true},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadAddressRequest"},"description":"Bcc recipients, each one bare email address.","nullable":true},"delaySeconds":{"type":"integer","description":"The undo window before the forward sends, 60 or 300 seconds. Omitted, it is 60.","format":"int32","nullable":true},"archiveAfterSend":{"type":"boolean","description":"Archive the thread once the forward sends."},"attachmentIds":{"type":"array","items":{"type":"string"},"description":"The `att_` ids of files uploaded with `POST /v1/attachments` against the thread's newest message.","nullable":true}},"additionalProperties":false,"description":"A forward of an email thread.","example":{"body":"<p>Jordan, Amanda wants a call on Thursday afternoon. Can you take it?</p>","senderEmailId":5530,"contentType":"html","replyAll":false,"injectPreviousEmailBody":true,"useDedicatedIps":false,"to":[{"name":"Jordan Patel","address":"jordan.patel@northwind-outbound.example.com"}],"delaySeconds":60,"archiveAfterSend":false}},"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."},"MarkAllThreadsRead":{"type":"object","properties":{"updatedCount":{"type":"integer","description":"How many email messages, LinkedIn conversations and Instagram, WhatsApp, Facebook and iMessage chats Kenso marked read\n(each chat channel while it is on). A repeat call returns 0.","format":"int64"}},"additionalProperties":false,"description":"The result of marking every thread read.","example":{"updatedCount":3}},"MarkAllThreadsReadResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/MarkAllThreadsRead"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"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."},"MessageAttachment":{"type":"object","properties":{"id":{"type":"string","description":"The `att_` id that `GET /v1/attachments/{attachmentId}/content` downloads. Omitted when Kenso cannot\nserve the file, as for an older message whose original email Kenso did not store.","nullable":true},"fileName":{"type":"string","description":"The file name the email gives. Null when it gives none.","nullable":true},"contentType":{"type":"string","description":"The MIME type the email gives, such as `image/png`.","nullable":true},"sizeBytes":{"type":"integer","description":"The file size in bytes. Null when unknown.","format":"int64","nullable":true},"isInline":{"type":"boolean","description":"True for a part the email shows in its body, such as an inline image."},"contentId":{"type":"string","description":"The MIME Content-ID an HTML body's `cid:` image refers to, without the `cid:` scheme.","nullable":true}},"additionalProperties":false,"description":"A file on an email message, inline images included."},"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."},"PersonChannels":{"type":"object","properties":{"email":{"type":"integer","description":"Email threads.","format":"int32"},"linkedin":{"type":"integer","description":"LinkedIn chats.","format":"int32"},"instagram":{"type":"integer","description":"Instagram chats matched to the person (0 unless the workspace has Instagram on).","format":"int32"},"whatsapp":{"type":"integer","description":"WhatsApp chats matched to the person (0 unless the workspace has WhatsApp on).","format":"int32"},"imessage":{"type":"integer","description":"iMessage threads. Present only while iMessage is on for the workspace.","format":"int32","nullable":true}},"additionalProperties":false,"description":"A person's thread counts by channel, on a `groupBy=person` or `personKey` row."},"PersonThread":{"type":"object","properties":{"id":{"type":"string","description":"The thread's `thr_` id."},"channel":{"type":"string","description":"The channel: `email`, `linkedin`, `instagram`, `facebook`, `whatsapp` or `imessage`."},"direction":{"type":"string","description":"Only on `GET /v1/threads`: who sent the newest message the row shows, `inbound` (the contact) or\n`outbound` (the workspace). On an outbound email row `fromName` is yours, so the contact is the first\nentry of `to`. A LinkedIn row's `fromName` is the contact either way. Omitted from a single thread and\nfrom updates, whose messages carry their own direction.","nullable":true},"campaignId":{"type":"integer","description":"The campaign the thread belongs to. Null for a thread outside any campaign.","format":"int64","nullable":true},"contactId":{"type":"integer","description":"The contact the thread is with. Null when Kenso matched no contact.","format":"int64","nullable":true},"accountId":{"type":"integer","description":"The account the thread belongs to: the account whose touch the thread is. `GET /v1/threads/{threadId}` falls\nback to the account where the thread's contact is a stakeholder, matched by email, else LinkedIn URL. Omitted when\nthere is none, when the account is outside the accounts the caller may see, or while the accounts feature is off\nfor the caller.","format":"int64","nullable":true},"accountName":{"type":"string","description":"The name of the `accountId` account. Omitted with it.","nullable":true},"replyTouchId":{"type":"integer","description":"Email threads of an account touch, on lists and `GET /v1/threads/{threadId}`: the account's open reply touch\nthat answers a message in this thread, the newest when there are several. Its status is `planned`,\n`drafted`, `awaiting_approval` or `approved`. Send the reply by approving the touch with\n`POST /v1/touches/{touchId}/approve`, so the account's plan records it. Omitted without `accountId`, on\nLinkedIn threads, when there is none or Kenso could not read it, and from updates.","format":"int64","nullable":true},"hasDraft":{"type":"boolean","description":"True when a reply draft is saved on the thread, whoever wrote it. `GET /v1/threads/{threadId}/draft` returns\nit. False when Kenso could not read the draft."},"draftAuthor":{"type":"string","description":"Who last wrote the draft: `user` (a person in the Kenso app) or `agent` (an agent or API key). Omitted\nwithout a draft.","nullable":true},"inboxId":{"type":"integer","description":"The thread's inbox. For a LinkedIn thread, the LinkedIn account. For an iMessage thread, its line's id. For an email thread, the workspace inbox its\nmessage was sent to (a reply you received) or sent from (your own), even when that inbox was deleted since. On\n`GET /v1/threads` the message is the row's. On `GET /v1/threads/{threadId}` it is the newest inbound\nmessage, else the newest. Omitted when the message names no inbox of the workspace.","format":"int64","nullable":true},"subject":{"type":"string","description":"The subject of the thread's email. Null when it has none.","nullable":true},"preview":{"type":"string","description":"The newest message's text for a preview, or its HTML when it has no text part.","nullable":true},"isRead":{"type":"boolean","description":"True when the thread is marked read."},"isArchived":{"type":"boolean","description":"True when the thread is archived."},"isSaved":{"type":"boolean","description":"True when the thread is saved."},"interest":{"type":"string","description":"The label on the thread's newest reply: `interested`, `question`, `not_interested`, `negative`,\n`automated`, `unclassified`, `unsubscribe`, `objection`, `wrong_contact`,\n`referral`, `out_of_office`, `hard_bounce`, `soft_bounce`, `complaint`, `unknown` or\n`ndr` (a non-delivery report). `unclassified` when it has no label."},"reminderAt":{"type":"string","description":"When the reminder on the thread is due, in UTC. Null without a reminder.","format":"date-time","nullable":true},"lastMessageAt":{"type":"string","description":"When the newest message was sent or received, in UTC.","format":"date-time"},"waitingSince":{"type":"string","description":"Only on `GET /v1/threads`: when the contact's newest message arrived, on any tab. It is a wait on your reply\nonly on the To Reply tab: a thread marked done or archived still carries it. A thread you answered whose reminder came\ndue is on To Reply for that reminder, so it carries the reminder's due time. Omitted when the newest message is\nyours and no reminder is due.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"When the thread last changed, in UTC.","format":"date-time"},"senderName":{"type":"string","description":"The same value as `fromName`.","nullable":true},"fromName":{"type":"string","description":"Email: the name of the newest message's sender, yours when that message is outbound. LinkedIn: the contact's\nname, omitted when the conversation names nobody.","nullable":true},"fromEmailAddress":{"type":"string","description":"Email only: the address of the newest message's sender.","nullable":true},"htmlBody":{"type":"string","description":"Email only: the newest message's body as HTML.","nullable":true},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ThreadTag"},"description":"The tags on the thread.","nullable":true},"to":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the newest message's To recipients.","nullable":true},"cc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the newest message's Cc recipients.","nullable":true},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the newest message's Bcc recipients.","nullable":true},"scheduledMessages":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledMessage"},"description":"Only on `GET /v1/threads/{threadId}` for an email thread: the replies and forwards queued on this thread that\nhave not sent yet, in `scheduled`, `sending` or `awaiting_approval` status, the soonest due\nfirst. An empty list means none are pending. Omitted from lists, from updates, and when Kenso could not read them.","nullable":true},"referral":{"allOf":[{"$ref":"#/components/schemas/ThreadReferral"}],"description":"The person a recruiting reply referred you to, when its `interest` is `referral`. Set on\n`GET /v1/threads/{threadId}` for an email thread. Null on lists, on LinkedIn threads and for every other\nreply."},"browserRun":{"allOf":[{"$ref":"#/components/schemas/ThreadBrowserRun"}],"description":"The workflow browser run whose web form submission this thread answers, or null. Set on `GET /v1/threads`\nrows and `GET /v1/threads/{threadId}`. The Kenso app labels such a thread as a browser run and never counts\nit as a reply."},"language":{"type":"string","description":"The language of the newest inbound message, as an ISO 639-1 code such as `en`. On `GET /v1/threads` an\nemail row carries its own message's, so a row whose newest message is yours has none. Omitted when unknown.","nullable":true},"imessage":{"allOf":[{"$ref":"#/components/schemas/ThreadImessage"}],"description":"iMessage only: the line, the number, whether the person replied (images and voice notes need it) and whether the\nthread goes by SMS (text only). Omitted on other channels."},"historyStartsAt":{"type":"string","description":"Facebook only: the oldest point this thread's history reaches while the account's history is locked. Omitted once\nit is unlocked and on every other channel.","format":"date-time","nullable":true},"personKey":{"type":"string","description":"Present only with `groupBy=person` or `personKey`: the person's key. It is `per_` with the\nperson's id, else `con_` with the contact's id, else the row's own `thr_` id."},"personId":{"type":"integer","description":"Present only with `groupBy=person` or `personKey`: the person's id behind a `per_` key, after any\nmerge. Null for other keys.","format":"int64","nullable":true},"personName":{"type":"string","description":"Present only with `groupBy=person` or `personKey`: the person's full name behind a `per_` key.\nNull for other keys.","nullable":true},"channels":{"allOf":[{"$ref":"#/components/schemas/PersonChannels"}],"description":"Present only with `groupBy=person` or `personKey`: the person's email threads and LinkedIn chats across\nevery tab."},"waitingCount":{"type":"integer","description":"Present only with `groupBy=person` or `personKey`: how many of the person's threads the To Reply tab\nlists, the number `GET /v1/threads?status=to_reply` shows for them. A reminder that came due counts, and an\nout-of-office reply does not.","format":"int32"},"threadIds":{"type":"array","items":{"type":"string"},"description":"Present only with `groupBy=person` or `personKey`: the person's `thr_` ids across every tab, newest\nfirst, at most 200."}},"additionalProperties":false,"description":"A thread row of `GET /v1/threads`. The thread fields are on every row. `personKey`, `personId`,\n`personName`, `channels`, `waitingCount` and `threadIds` are present only with\n`groupBy=person` or `personKey`, and every other list leaves them out.","example":{"id":"thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20","channel":"email","direction":"inbound","campaignId":4821,"contactId":90125,"hasDraft":false,"inboxId":5530,"subject":"Re: Onboarding new engineers at Northwind Labs","preview":"Thanks Alex, this is timely. We are hiring 12 engineers this quarter. Could we talk Thursday afternoon?","isRead":false,"isArchived":false,"isSaved":false,"interest":"interested","lastMessageAt":"2026-10-13T16:22:05Z","waitingSince":"2026-10-13T16:22:05Z","updatedAt":"2026-10-13T16:22:05Z","senderName":"Amanda Chen","fromName":"Amanda Chen","fromEmailAddress":"amanda.chen@northwind.example.com","htmlBody":"<p>Thanks Alex, this is timely. We are hiring 12 engineers this quarter.</p><p>Could we talk Thursday afternoon?</p><p>Amanda</p>","tags":[{"id":341,"name":"Hot lead","color":"#FFD6A5"}],"to":[{"name":"Alex Rivera","address":"alex@mail.example.com"}],"language":"en","personKey":"per_48213","personId":48213,"personName":"Amanda Chen","channels":{"email":1,"linkedin":0,"instagram":0,"whatsapp":0},"waitingCount":1,"threadIds":["thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20"]}},"PersonThreadListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/PersonThread"},"description":"The items on this page."},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Where this page ends and how to get the next one."}},"additionalProperties":false,"description":"The body of a successful list operation: one page of results in `data`, and `pagination` to get the next\npage."},"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."},"ReactThreadMessageRequest":{"type":"object","properties":{"reaction":{"type":"string","description":"love, like, dislike, laugh, emphasize, question, or one emoji; null removes your tapback.","nullable":true}},"additionalProperties":false,"description":"A tapback on a received iMessage text.","example":{"reaction":"love"}},"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."},"ScheduledMessage":{"type":"object","properties":{"id":{"type":"integer","description":"The scheduled message's id. `POST /v1/scheduled-messages/{scheduledMessageId}/cancel` takes it.","format":"int64"},"messageId":{"type":"string","description":"The `msg_` id of the message it replies to or forwards.","nullable":true},"kind":{"type":"string","description":"The kind of message: `reply` or `forward`."},"status":{"type":"string","description":"The message's status: `scheduled`, `sending`, `sent`, `cancelled`, `failed` or\n`awaiting_approval`."},"approverMemberId":{"type":"integer","description":"With status `awaiting_approval`: the member who must approve the message before it sends, the owner of the\nsending mailbox. `GET /v1/members` gives their name.","format":"int64","nullable":true},"delaySeconds":{"type":"integer","description":"The undo window in seconds, 60 or 300.","format":"int32"},"sendAt":{"type":"string","description":"When Kenso sends the message, in UTC.","format":"date-time"},"createdAt":{"type":"string","description":"When Kenso queued the message, in UTC.","format":"date-time"},"body":{"type":"string","description":"The message's body.","nullable":true},"senderEmailId":{"type":"integer","description":"The id of the inbox that sends the message.","format":"int32","nullable":true},"to":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"The To recipients. Null when none were named.","nullable":true},"cc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"The Cc recipients. Null when none were named.","nullable":true},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"The Bcc recipients. Null when none were named.","nullable":true},"draft":{"allOf":[{"$ref":"#/components/schemas/ScheduledMessageDraft"}],"description":"On a cancel: the message, saved back as the thread's draft."}},"additionalProperties":false,"description":"An email reply or forward that Kenso queued to send after its undo window.","example":{"id":66012,"messageId":"msg_ZW1haWw6NDAyMjg0LjJAZXhhbXBsZS5jb20","kind":"forward","status":"scheduled","delaySeconds":60,"sendAt":"2026-10-13T16:31:12Z","createdAt":"2026-10-13T16:30:12Z","body":"<p>Jordan, Amanda wants a call on Thursday afternoon. Can you take it?</p>","senderEmailId":5530,"to":[{"name":"Jordan Patel","address":"jordan.patel@northwind-outbound.example.com"}]}},"ScheduledMessageDraft":{"type":"object","properties":{"messageId":{"type":"string","description":"The `msg_` id of the message the draft replies to or forwards.","nullable":true},"kind":{"type":"string","description":"The kind of message: `reply` or `forward`."},"body":{"type":"string","description":"The draft's body."},"senderEmailId":{"type":"integer","description":"The id of the inbox the draft sends from.","format":"int32","nullable":true},"to":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"The draft's To recipients. Null when none.","nullable":true},"cc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"The draft's Cc recipients. Null when none.","nullable":true},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"The draft's Bcc recipients. Null when none.","nullable":true},"saved":{"type":"boolean","description":"False when the cancel went through but Kenso could not save this draft as the thread's draft. The draft is still\nhere, so save it yourself."}},"additionalProperties":false,"description":"A cancelled message, saved back as the thread's draft."},"ScheduledMessageResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ScheduledMessage"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ServiceUnavailableError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The body of a `503`: the error body (`Failure`). When Kenso cannot check the API key, its code is `auth_unavailable`, with `Retry-After: 5`. Until November 2026 the API key check in front of the operations answered `{ \"error\": \"Authentication is temporarily unavailable\" }` (`ApiKeyError`) there instead, so handle both shapes. Retry after the `Retry-After` seconds."},"Thread":{"type":"object","properties":{"id":{"type":"string","description":"The thread's `thr_` id."},"channel":{"type":"string","description":"The channel: `email`, `linkedin`, `instagram`, `facebook`, `whatsapp` or `imessage`."},"direction":{"type":"string","description":"Only on `GET /v1/threads`: who sent the newest message the row shows, `inbound` (the contact) or\n`outbound` (the workspace). On an outbound email row `fromName` is yours, so the contact is the first\nentry of `to`. A LinkedIn row's `fromName` is the contact either way. Omitted from a single thread and\nfrom updates, whose messages carry their own direction.","nullable":true},"campaignId":{"type":"integer","description":"The campaign the thread belongs to. Null for a thread outside any campaign.","format":"int64","nullable":true},"contactId":{"type":"integer","description":"The contact the thread is with. Null when Kenso matched no contact.","format":"int64","nullable":true},"accountId":{"type":"integer","description":"The account the thread belongs to: the account whose touch the thread is. `GET /v1/threads/{threadId}` falls\nback to the account where the thread's contact is a stakeholder, matched by email, else LinkedIn URL. Omitted when\nthere is none, when the account is outside the accounts the caller may see, or while the accounts feature is off\nfor the caller.","format":"int64","nullable":true},"accountName":{"type":"string","description":"The name of the `accountId` account. Omitted with it.","nullable":true},"replyTouchId":{"type":"integer","description":"Email threads of an account touch, on lists and `GET /v1/threads/{threadId}`: the account's open reply touch\nthat answers a message in this thread, the newest when there are several. Its status is `planned`,\n`drafted`, `awaiting_approval` or `approved`. Send the reply by approving the touch with\n`POST /v1/touches/{touchId}/approve`, so the account's plan records it. Omitted without `accountId`, on\nLinkedIn threads, when there is none or Kenso could not read it, and from updates.","format":"int64","nullable":true},"hasDraft":{"type":"boolean","description":"True when a reply draft is saved on the thread, whoever wrote it. `GET /v1/threads/{threadId}/draft` returns\nit. False when Kenso could not read the draft."},"draftAuthor":{"type":"string","description":"Who last wrote the draft: `user` (a person in the Kenso app) or `agent` (an agent or API key). Omitted\nwithout a draft.","nullable":true},"inboxId":{"type":"integer","description":"The thread's inbox. For a LinkedIn thread, the LinkedIn account. For an iMessage thread, its line's id. For an email thread, the workspace inbox its\nmessage was sent to (a reply you received) or sent from (your own), even when that inbox was deleted since. On\n`GET /v1/threads` the message is the row's. On `GET /v1/threads/{threadId}` it is the newest inbound\nmessage, else the newest. Omitted when the message names no inbox of the workspace.","format":"int64","nullable":true},"subject":{"type":"string","description":"The subject of the thread's email. Null when it has none.","nullable":true},"preview":{"type":"string","description":"The newest message's text for a preview, or its HTML when it has no text part.","nullable":true},"isRead":{"type":"boolean","description":"True when the thread is marked read."},"isArchived":{"type":"boolean","description":"True when the thread is archived."},"isSaved":{"type":"boolean","description":"True when the thread is saved."},"interest":{"type":"string","description":"The label on the thread's newest reply: `interested`, `question`, `not_interested`, `negative`,\n`automated`, `unclassified`, `unsubscribe`, `objection`, `wrong_contact`,\n`referral`, `out_of_office`, `hard_bounce`, `soft_bounce`, `complaint`, `unknown` or\n`ndr` (a non-delivery report). `unclassified` when it has no label."},"reminderAt":{"type":"string","description":"When the reminder on the thread is due, in UTC. Null without a reminder.","format":"date-time","nullable":true},"lastMessageAt":{"type":"string","description":"When the newest message was sent or received, in UTC.","format":"date-time"},"waitingSince":{"type":"string","description":"Only on `GET /v1/threads`: when the contact's newest message arrived, on any tab. It is a wait on your reply\nonly on the To Reply tab: a thread marked done or archived still carries it. A thread you answered whose reminder came\ndue is on To Reply for that reminder, so it carries the reminder's due time. Omitted when the newest message is\nyours and no reminder is due.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"When the thread last changed, in UTC.","format":"date-time"},"senderName":{"type":"string","description":"The same value as `fromName`.","nullable":true},"fromName":{"type":"string","description":"Email: the name of the newest message's sender, yours when that message is outbound. LinkedIn: the contact's\nname, omitted when the conversation names nobody.","nullable":true},"fromEmailAddress":{"type":"string","description":"Email only: the address of the newest message's sender.","nullable":true},"htmlBody":{"type":"string","description":"Email only: the newest message's body as HTML.","nullable":true},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ThreadTag"},"description":"The tags on the thread.","nullable":true},"to":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the newest message's To recipients.","nullable":true},"cc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the newest message's Cc recipients.","nullable":true},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the newest message's Bcc recipients.","nullable":true},"scheduledMessages":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledMessage"},"description":"Only on `GET /v1/threads/{threadId}` for an email thread: the replies and forwards queued on this thread that\nhave not sent yet, in `scheduled`, `sending` or `awaiting_approval` status, the soonest due\nfirst. An empty list means none are pending. Omitted from lists, from updates, and when Kenso could not read them.","nullable":true},"referral":{"allOf":[{"$ref":"#/components/schemas/ThreadReferral"}],"description":"The person a recruiting reply referred you to, when its `interest` is `referral`. Set on\n`GET /v1/threads/{threadId}` for an email thread. Null on lists, on LinkedIn threads and for every other\nreply."},"browserRun":{"allOf":[{"$ref":"#/components/schemas/ThreadBrowserRun"}],"description":"The workflow browser run whose web form submission this thread answers, or null. Set on `GET /v1/threads`\nrows and `GET /v1/threads/{threadId}`. The Kenso app labels such a thread as a browser run and never counts\nit as a reply."},"language":{"type":"string","description":"The language of the newest inbound message, as an ISO 639-1 code such as `en`. On `GET /v1/threads` an\nemail row carries its own message's, so a row whose newest message is yours has none. Omitted when unknown.","nullable":true},"imessage":{"allOf":[{"$ref":"#/components/schemas/ThreadImessage"}],"description":"iMessage only: the line, the number, whether the person replied (images and voice notes need it) and whether the\nthread goes by SMS (text only). Omitted on other channels."},"historyStartsAt":{"type":"string","description":"Facebook only: the oldest point this thread's history reaches while the account's history is locked. Omitted once\nit is unlocked and on every other channel.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"An email thread, a LinkedIn conversation, an Instagram chat, a Facebook chat or a WhatsApp chat in the workspace's inbox.","example":{"id":"thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20","channel":"email","direction":"inbound","campaignId":4821,"contactId":90125,"hasDraft":false,"inboxId":5530,"subject":"Re: Onboarding new engineers at Northwind Labs","preview":"Thanks Alex, this is timely. We are hiring 12 engineers this quarter. Could we talk Thursday afternoon?","isRead":false,"isArchived":false,"isSaved":false,"interest":"interested","lastMessageAt":"2026-10-13T16:22:05Z","waitingSince":"2026-10-13T16:22:05Z","updatedAt":"2026-10-13T16:22:05Z","senderName":"Amanda Chen","fromName":"Amanda Chen","fromEmailAddress":"amanda.chen@northwind.example.com","htmlBody":"<p>Thanks Alex, this is timely. We are hiring 12 engineers this quarter.</p><p>Could we talk Thursday afternoon?</p><p>Amanda</p>","tags":[{"id":341,"name":"Hot lead","color":"#FFD6A5"}],"to":[{"name":"Alex Rivera","address":"alex@mail.example.com"}],"language":"en"}},"ThreadAddressRequest":{"required":["address"],"type":"object","properties":{"name":{"type":"string","description":"The display name. Optional.","nullable":true},"address":{"type":"string","description":"Required. One bare email address, such as `jane@acme.com`."}},"additionalProperties":false,"description":"An email recipient."},"ThreadBrowserRun":{"type":"object","properties":{"runId":{"type":"string","description":"The browser run's id, as a string."},"automated":{"type":"boolean","description":"True when the headers and the sender show that a machine sent the email, such as a form confirmation or a\nnotification."}},"additionalProperties":false,"description":"The workflow browser run whose web form submission a thread or message answers."},"ThreadBulkError":{"type":"object","properties":{"code":{"type":"string","description":"The error code, as `PATCH /v1/threads/{threadId}` answers it for that thread: `not_found`,\n`validation_failed`, or `internal_error` when Kenso could not update it for a fault of its own (try it\nagain in a new request: the same `Idempotency-Key` replays this answer for 24 hours)."},"message":{"type":"string","description":"A readable explanation."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"What failed, as `error.details` of the same `PATCH` names it: each item's `field` and detail\n`code`. On an iMessage thread an `interest` refusal names `imessage_no_inbound` (the person has not\ntexted the thread yet) or `imessage_newer_text` (a newer text from them arrived first: reload the thread and set\nit again in a new request). Omitted when the failure has no detail.","nullable":true}},"additionalProperties":false,"description":"Why one thread in a bulk update failed."},"ThreadBulkFailure":{"type":"object","properties":{"id":{"type":"string","description":"The id as you sent it."},"error":{"allOf":[{"$ref":"#/components/schemas/ThreadBulkError"}],"description":"Why the update failed."}},"additionalProperties":false,"description":"A thread a bulk update could not change."},"ThreadBulkResult":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"string"},"description":"The `thr_` ids Kenso updated."},"failed":{"type":"array","items":{"$ref":"#/components/schemas/ThreadBulkFailure"},"description":"The ids Kenso could not update, each with its error."}},"additionalProperties":false,"description":"The outcome of a bulk thread update.","example":{"succeeded":["thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20"],"failed":[{"id":"thr_ZW1haWw6NDAyMzE3LjFAZXhhbXBsZS5jb20","error":{"code":"not_found","message":"No thread with this id in the workspace."}}]}},"ThreadBulkResultResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadBulkResult"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadCampaignCount":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The campaign's id.","format":"int64"},"campaignName":{"type":"string","description":"The campaign's name. Omitted when the campaign has no name.","nullable":true},"threadCount":{"type":"integer","description":"The campaign's threads in the requested tab, 0 when none are in it. With `groupBy=person`, people.","format":"int64"}},"additionalProperties":false,"description":"One campaign's thread count in the requested tab."},"ThreadCounts":{"type":"object","properties":{"allCount":{"type":"integer","description":"Threads in the requested tab: the number `GET /v1/threads` lists with the same tab filters. With\n`groupBy=person`, people.","format":"int64"},"accountsCount":{"type":"integer","description":"Threads in the requested tab that are linked to an account. With `groupBy=person`, people.","format":"int64"},"campaignsCount":{"type":"integer","description":"Threads in the requested tab that belong to a campaign. With `groupBy=person`, people.","format":"int64"},"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/ThreadCampaignCount"},"description":"Every campaign with a thread in the inbox, the most recent activity first. A campaign with no thread in the\nrequested tab has `threadCount` 0."},"toReplyCount":{"type":"integer","description":"Threads on the To Reply tab, whatever tab you request. With `groupBy=person`, people.","format":"int64"},"unreadCount":{"type":"integer","description":"Threads with an unread inbound message, whatever tab you request. With `groupBy=person`, people.","format":"int64"},"latestMessageAt":{"type":"string","description":"When the newest inbound message arrived, in UTC. Omitted when the inbox is empty.","format":"date-time","nullable":true},"inboxChangedAt":{"type":"string","description":"When the inbox last changed, in UTC. An inbound email that arrives or changes moves it, such as a reply that\nsyncs late, a reply Kenso moves to another tab, or a read. So does a change to a LinkedIn conversation whose last\nmessage is inbound, and to an Instagram, WhatsApp or iMessage chat the counts cover. It is not a message time. Poll it and reload the list when it changes. Omitted when the inbox\nis empty.","format":"date-time","nullable":true},"facebookUnreadCount":{"type":"integer","description":"Facebook threads with an unread inbound message. Omitted when Facebook outreach is off for the workspace.","format":"int64","nullable":true}},"additionalProperties":false,"description":"Thread counts for the inbox tabs: email and LinkedIn threads, matched Instagram and WhatsApp chats while those channels\nare on, and iMessage threads while the workspace's `imessage` flag is on.","example":{"allCount":42,"accountsCount":6,"campaignsCount":40,"campaigns":[{"campaignId":4821,"campaignName":"Q4 SaaS founders","threadCount":40}],"toReplyCount":7,"unreadCount":3,"latestMessageAt":"2026-10-13T16:22:05Z","inboxChangedAt":"2026-10-13T16:22:05Z"}},"ThreadCountsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadCounts"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadDraft":{"type":"object","properties":{"threadId":{"type":"string","description":"The `thr_` id of the thread."},"subject":{"type":"string","description":"Email only: the draft's subject. Null when it has none.","nullable":true},"body":{"type":"string","description":"The draft's text."},"authorSource":{"type":"string","description":"Who last wrote the draft: `user` (a person in the Kenso app) or `agent` (an agent or API key). An agent\nnever overwrites a person's draft."},"mirror":{"allOf":[{"$ref":"#/components/schemas/ThreadDraftMirror"}],"description":"When an agent wrote the reply in the contact's language: the same reply in the reader's language, as plain text.\nNull otherwise. A person's save that changes the body clears it."},"updatedAt":{"type":"string","description":"When the draft last changed, in UTC.","format":"date-time"},"agentJobId":{"type":"integer","description":"Email only: the reply-agent job this draft came from, rated as `reply_job:{agentJobId}`. Omitted for a\ndraft a person wrote.","format":"int64","nullable":true},"gapId":{"type":"integer","description":"Email only: the open question Ken needs answered for this draft, whose body holds a {gap} blank. Omitted otherwise.","format":"int64","nullable":true},"gapQuestion":{"type":"string","description":"The question of `gapId`, as Ken asked it. Omitted with `gapId`.","nullable":true}},"additionalProperties":false,"description":"The reply draft saved on a thread.","example":{"threadId":"thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20","subject":"Re: Onboarding new engineers at Northwind Labs","body":"<p>Hi Amanda,</p><p>Thursday works. Does 2pm Central suit you? I will send an invite.</p><p>Alex</p>","authorSource":"agent","updatedAt":"2026-10-13T16:25:40Z"}},"ThreadDraftMirror":{"type":"object","properties":{"text":{"type":"string","description":"The reply as plain text with line breaks."},"language":{"type":"string","description":"The ISO 639-1 code of `text`, such as `en`."}},"additionalProperties":false,"description":"A draft in the reader's language."},"ThreadDraftResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadDraft"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadImage":{"type":"object","properties":{"id":{"type":"string","description":"The image's id (`img_`), passed in `imageIds` on `POST /v1/threads/{threadId}/messages`."},"contentType":{"type":"string","description":"`image/jpeg`, `image/png` or `image/webp`, read from the file's content."},"sizeBytes":{"type":"integer","description":"The image's size in bytes.","format":"int64"}},"additionalProperties":false,"description":"An image waiting on a Facebook thread for the next reply (task 12).","example":{"id":"img_7Qm2xV9pLk3Rt8Wz","contentType":"image/png","sizeBytes":184320}},"ThreadImageResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadImage"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadImessage":{"type":"object","properties":{"lineId":{"type":"integer","description":"The workspace's iMessage line the thread is on (`GET /v1/imessage-lines/{lineId}`).","format":"int64"},"phone":{"type":"string","description":"The person's number in E.164 (`+14155550100`)."},"hasReplied":{"type":"boolean","description":"The person texted this line at least once. Images and voice notes go only after that."},"isSmsThread":{"type":"boolean","description":"The thread goes by SMS (green bubbles): text only, no images or voice notes. A tapback there arrives as a text, so\nonly a member sends one; an agent's or API key's is `409` `imessage_sms_thread`."},"personId":{"type":"integer","description":"The person the conversation is with: the `personId` to make a voice note for this thread with\n(`POST /v1/voice-notes`). Omitted when the conversation has no person.","format":"int64","nullable":true},"isNameless":{"type":"boolean","description":"No name was found for the person on this thread, so the thread's `fromName` and `senderName` are their\nnumber. Show the thread as a conversation with an unknown person."},"voiceNoteInProgress":{"allOf":[{"$ref":"#/components/schemas/ThreadVoiceNoteInProgress"}],"description":"The voice note Kenso is making for this thread right now (`POST /v1/voice-notes` with this thread's\n`threadId`), so the app can show it being made after a reload instead of starting a second one. Poll it with\n`GET /v1/voice-notes/{voiceNoteId}`. Omitted when none is being made."},"ownerName":{"type":"string","description":"The member who owns the thread's line: texts on this thread go out in their name. Their first and last name, else\ntheir email. Omitted when the owner's account is gone.","nullable":true},"ownerLeft":{"type":"boolean","description":"The line's owner can't send from it anymore (they are no longer an active member of the workspace, or are a network\nmember), so nothing goes on this thread until an admin gives the line a new owner in Delivery. Always false for a\nreleased or failed line."},"voiceNoteReady":{"allOf":[{"$ref":"#/components/schemas/ThreadVoiceNoteReady"}],"description":"The newest voice note you made for this thread in the last 30 minutes (`POST /v1/voice-notes` with this thread's\n`threadId`, or with neither a touch nor a thread while this was the person's latest thread) that is ready and\nnot sent yet, so a create that timed out on your side but finished is offered instead of made and charged again.\nOnly a note the calling member asked for (`createdByMemberId`); never another member's, and none for an API key\nwith no member. Only on a single thread\n(`GET /v1/threads/{threadId}` and the thread an update returns), never on a list row; omitted when there is none.\nA read that fails fails the thread read (500 `internal_error`), so a missing field always means there is no\nsuch note."}},"additionalProperties":false,"description":"An iMessage thread's line, number and reply state."},"ThreadImessageAttachment":{"type":"object","properties":{"contentType":{"type":"string","description":"The file's MIME type, when known.","nullable":true},"fileName":{"type":"string","description":"The file's name, when known.","nullable":true},"url":{"type":"string","description":"Where the file downloads: `GET /v1/threads/{threadId}/messages/{messageId}/attachments/{index}`, where\n`index` is the file's 0-based position in `attachments`. Requires Inbox view. Omitted when Kenso has no\nlink for the file.","nullable":true}},"additionalProperties":false,"description":"A file on an inbound iMessage text."},"ThreadImessageReaction":{"type":"object","properties":{"direction":{"type":"string","description":"`inbound` (the person's) or `outbound` (yours)."},"value":{"type":"string","description":"love, like, dislike, laugh, emphasize, question, or one emoji."},"at":{"type":"string","description":"When the tapback was set.","format":"date-time"}},"additionalProperties":false,"description":"A tapback on an iMessage text."},"ThreadMessage":{"type":"object","properties":{"id":{"type":"string","description":"The message's `msg_` id."},"threadId":{"type":"string","description":"The `thr_` id of the thread."},"channel":{"type":"string","description":"The channel: `email`, `linkedin`, `instagram`, `facebook`, `whatsapp` or `imessage`."},"kind":{"type":"string","description":"What the item is: `message` for an email or chat message. A LinkedIn thread read with\n`includeEvents=true` also lists `connection_note` (the note sent with the invitation, outbound) and\n`connection_accepted` (the accept, inbound, with an empty body). An Instagram chat also has\n`story_reply` and `story_mention` (a message about a story), and `notice`: an event Instagram writes\ninto the chat (for example that the person cannot receive the message), with no sender. Always set."},"direction":{"type":"string","description":"Who sent the message: `inbound` (the contact) or `outbound` (the workspace)."},"subject":{"type":"string","description":"The message's subject. Null when it has none.","nullable":true},"body":{"type":"string","description":"The message text.","nullable":true},"extractedText":{"type":"string","description":"Inbound email only: the sender's own words, without quoted history, signature, mobile footer and sign-off. Omitted\nfor outbound email, for LinkedIn, and for a message with no readable body. `body` keeps the full text.","nullable":true},"language":{"type":"string","description":"Inbound messages only: the message's language as an ISO 639-1 code, such as `en`. Omitted when unknown and\non outbound messages.","nullable":true},"occurredAt":{"type":"string","description":"When the message was sent or received, in UTC.","format":"date-time"},"scheduledMessageId":{"type":"integer","description":"On the response of `POST /v1/threads/{threadId}/messages`, email only: the queued reply's scheduled message\nid. Until its undo window ends, `POST /v1/scheduled-messages/{scheduledMessageId}/cancel` with this id stops\nit. Omitted otherwise.","format":"int64","nullable":true},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessageWarning"},"description":"Set on `POST /v1/threads/{threadId}/messages` when the reply went out past a safeguard you confirmed, and on\n`POST /v1/threads` when the new thread went out from an inbox that has not finished warmup. Omitted\notherwise.","nullable":true},"senderName":{"type":"string","description":"The same value as `fromName`.","nullable":true},"fromName":{"type":"string","description":"The sender's name.","nullable":true},"fromEmailAddress":{"type":"string","description":"Email only: the sender's address.","nullable":true},"htmlBody":{"type":"string","description":"Email only: the message as HTML.","nullable":true},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ThreadTag"},"description":"The tags on the message.","nullable":true},"to":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the To recipients.","nullable":true},"cc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the Cc recipients.","nullable":true},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRecipient"},"description":"Email only: the Bcc recipients.","nullable":true},"openCount":{"type":"integer","description":"Outbound email only: opens of the tracking pixel, without known proxies and crawlers. 0 when not opened or not\ntracked.","format":"int32","nullable":true},"rawOpenCount":{"type":"integer","description":"Outbound email only: every hit on the tracking pixel, proxies and prefetches included. Always at least\n`openCount`.","format":"int32","nullable":true},"firstOpenedAt":{"type":"string","description":"Outbound email only: the first recorded open, in UTC.","format":"date-time","nullable":true},"lastOpenedAt":{"type":"string","description":"Outbound email only: the latest recorded open, in UTC.","format":"date-time","nullable":true},"referral":{"allOf":[{"$ref":"#/components/schemas/ThreadReferral"}],"description":"Inbound email only: the person a recruiting reply referred you to, when its interest is `referral`. Null on\nLinkedIn messages and every other reply."},"browserRun":{"allOf":[{"$ref":"#/components/schemas/ThreadBrowserRun"}],"description":"The workflow browser run whose web form submission this inbound message answers, or null. The Kenso app labels\nsuch a message as a browser run and never counts it as a reply."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/MessageAttachment"},"description":"Email only, on `GET /v1/threads/{threadId}/messages`: the message's files, inline images included. Download\none with `GET /v1/attachments/{attachmentId}/content`. Omitted when the message has none.","nullable":true},"voiceNote":{"allOf":[{"$ref":"#/components/schemas/VoiceNoteRef"}],"description":"LinkedIn only: the message's voice note. A note Kenso sent carries its `voiceNoteId`, the script and, while\nKenso keeps the audio, `audioUrl`. A contact's note carries `voiceNoteId` 0, status `received` and\n`durationMs`. A note the account owner sent from LinkedIn itself is the same with status `sent`. Omitted\notherwise."},"voiceTranscript":{"type":"string","description":"WhatsApp only: the transcript of a voice note the contact sent, when one was made. Omitted otherwise.","nullable":true},"imessage":{"allOf":[{"$ref":"#/components/schemas/ThreadMessageImessage"}],"description":"iMessage only: delivery, failure, tapbacks and media. Omitted on other channels."},"sentBy":{"type":"string","description":"Email only: `agent` when Ken sent this message, either the reply agent (a reply a client approved first\nincluded) or a workflow's reply step, so the thread shows it as sent by Ken. Omitted on a message a person sent.","nullable":true},"agentJobId":{"type":"integer","description":"The reply-agent job whose draft went out as this message, rated as `reply_job:{agentJobId}` on the\n`reply_sent` surface. Omitted when `sentBy` is, or when the job is not known.","format":"int64","nullable":true},"quoteDroppedReason":{"type":"string","description":"Outbound email only: set when a reply or 1:1 follow-up went out without the earlier message Kenso quotes below it,\nbecause that message would have put a Kenso link in cold email. `brand_domain_in_quote`: the earlier message\nitself loads from a Kenso host or carries a Kenso tracking link. `brand_domain_when_joined`: each passes on its\nown, but the reply and the quote joined load from a Kenso host. The reply itself went out as written. Omitted when\nthe quote went out, and on messages sent before Kenso recorded it.","nullable":true}},"additionalProperties":false,"description":"One message in a thread, or a LinkedIn connection event.","example":{"id":"msg_ZW1haWw6NDAyMjg0LjJAZXhhbXBsZS5jb20","threadId":"thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20","channel":"email","kind":"message","direction":"inbound","subject":"Re: Onboarding new engineers at Northwind Labs","body":"Thanks Alex, this is timely. We are hiring 12 engineers this quarter. Could we talk Thursday afternoon?\n\nAmanda\n\nOn Tue, Oct 13, 2026 at 9:04 AM Alex Rivera <alex@mail.example.com> wrote:\n> Hi Amanda, following up on this.","extractedText":"Thanks Alex, this is timely. We are hiring 12 engineers this quarter. Could we talk Thursday afternoon?","language":"en","occurredAt":"2026-10-13T16:22:05Z","senderName":"Amanda Chen","fromName":"Amanda Chen","fromEmailAddress":"amanda.chen@northwind.example.com","htmlBody":"<p>Thanks Alex, this is timely. We are hiring 12 engineers this quarter.</p><p>Could we talk Thursday afternoon?</p><p>Amanda</p>","tags":[{"id":341,"name":"Hot lead","color":"#FFD6A5"}],"to":[{"name":"Alex Rivera","address":"alex@mail.example.com"}]}},"ThreadMessageAwaitingApproval":{"type":"object","properties":{"status":{"type":"string","description":"Always `awaiting_approval`."},"channel":{"type":"string","description":"`linkedin`, `whatsapp` or `imessage`."},"threadId":{"type":"string","description":"The `thr_` id of the thread."},"approvalId":{"type":"string","description":"The id of the approval item in `GET /v1/approvals`: of type `reply.linkedin` or `reply.whatsapp`,\nor `touch.imessage` (a `touch_` id) for an iMessage text.","nullable":true},"approverMemberId":{"type":"integer","description":"The member who must approve the reply: who connected the LinkedIn or WhatsApp account, or who owns the iMessage\nline the text goes from (the thread's line). An admin never approves an iMessage text in that owner's name.\n`GET /v1/members` gives their name.","format":"int64","nullable":true},"approverName":{"type":"string","description":"On an iMessage text, that member's first name, as the text is signed. Null when it is not known and on other\nchannels.","nullable":true},"body":{"type":"string","description":"The reply text that waits (on WhatsApp, a voice note's script).","nullable":true}},"additionalProperties":false,"description":"A LinkedIn, WhatsApp or iMessage reply that waits for a member's approval. An agent or API key sent it through a\nLinkedIn or WhatsApp account another member connected, or through any iMessage line (its owner's own agent or key\nincluded), and nothing was sent yet. Only `approverMemberId` can see and decide the item in\n`GET /v1/approvals`, and an iMessage text only in person: an agent or API key cannot approve it.","example":{"status":"awaiting_approval","channel":"linkedin","threadId":"thr_bGlua2VkaW46ODgxMjA0NA","approvalId":"lreply_77341","approverMemberId":1093,"body":"Thanks Amanda, Thursday at 2pm Central works. I will send an invite."}},"ThreadMessageAwaitingApprovalResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadMessageAwaitingApproval"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadMessageHeld":{"type":"object","properties":{"status":{"type":"string","description":"Always `held_for_client_approval`: Kenso sends the reply once the client approves it."},"clientApprovalItemId":{"type":"integer","description":"Id of the approval item for the reply. Read it with `GET /v1/client-approvals/items/{itemId}`.","format":"int64"},"threadId":{"type":"string","description":"Id of the thread the reply belongs to."}},"additionalProperties":false,"description":"A reply that waits for your client's approval. Kenso has not sent it yet.","example":{"status":"held_for_client_approval","clientApprovalItemId":5127,"threadId":"thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20"}},"ThreadMessageHeldResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadMessageHeld"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadMessageImessage":{"type":"object","properties":{"deliveredChannel":{"type":"string","description":"How the text was delivered: `imessage` or `sms`. Omitted until delivered.","nullable":true},"deliveredAt":{"type":"string","description":"When the text was delivered. Omitted until delivered.","format":"date-time","nullable":true},"failedAt":{"type":"string","description":"When delivery failed. Omitted unless it failed.","format":"date-time","nullable":true},"errorCode":{"type":"string","description":"A code for why delivery failed. Omitted unless it failed.","nullable":true},"reactions":{"type":"array","items":{"$ref":"#/components/schemas/ThreadImessageReaction"},"description":"The tapbacks on the text, at most one per direction (`inbound`: the person's, `outbound`: yours)."},"mediaCount":{"type":"integer","description":"How many images the text carried.","format":"int32"},"voiceNoteId":{"type":"integer","description":"The voice note the text carried; `GET /v1/voice-notes/{voiceNoteId}/imessage-audio` plays it. Omitted when none.","format":"int64","nullable":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ThreadImessageAttachment"},"description":"Files the person sent with an inbound text. Each file's `url` is a Kenso route that downloads it."}},"additionalProperties":false,"description":"One iMessage text's delivery, failure, tapbacks and media."},"ThreadMessageListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessage"},"description":"The items on this page."},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Where this page ends and how to get the next one."}},"additionalProperties":false,"description":"The body of a successful list operation: one page of results in `data`, and `pagination` to get the next\npage."},"ThreadMessageReaction":{"type":"object","properties":{"messageId":{"type":"string","description":"The `msg_` id of the text."},"threadId":{"type":"string","description":"The `thr_` id of the thread."},"reaction":{"type":"string","description":"Your tapback on the text now; null after a removal.","nullable":true},"reactedAt":{"type":"string","description":"When the tapback was set; omitted after a removal.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Your tapback on an iMessage text, as `PUT /v1/threads/{threadId}/messages/{messageId}/reaction` answers it.","example":{"messageId":"msg_aW1lc3NhZ2U6MTEwMjQ3NQ","threadId":"thr_aW1lc3NhZ2U6NTUxMjA0","reaction":"love","reactedAt":"2026-10-24T10:15:03Z"}},"ThreadMessageReactionResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadMessageReaction"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadMessageResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadMessage"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadMessageWarning":{"type":"object","properties":{"code":{"type":"string","description":"What the warning is about: `suppressed_contact_overridden` (on a reply) or `warmup_not_ready` (on a new\nthread)."},"reason":{"type":"string","description":"With `suppressed_contact_overridden`, the suppression reason: `do_not_contact`, `blocklisted` or\n`unsubscribed`. With `warmup_not_ready`, the warmup state: `too_young` or `unconfirmed`.","nullable":true},"fix":{"type":"string","description":"With `warmup_not_ready`: what to do. The email was sent, so pick an inbox that finished warmup for the next\none.","nullable":true},"readyAt":{"type":"string","description":"With `warmup_not_ready` and `too_young`: the day the inbox is ready, in UTC.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"A warning on a message that went out."},"ThreadMessages":{"type":"object","properties":{"threadId":{"type":"string","description":"The thread's `thr_` id, as you sent it."},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessage"},"description":"Every message of the thread, oldest first, as `GET /v1/threads/{threadId}/messages` lists them, with two\ndifferences: `htmlBody` is left out unless you ask with `includeHtml=true`, and `sentBy` and\n`agentJobId` are never set."}},"additionalProperties":false,"description":"One thread's messages in a batch read."},"ThreadMessagesBatch":{"type":"object","properties":{"threads":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessages"},"description":"One item per thread Kenso read, in the order you sent the ids. An id sent twice is answered once."},"failed":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessagesFailure"},"description":"The ids Kenso did not read, each with its error, in the order you sent them."}},"additionalProperties":false,"description":"The messages of several threads, as `GET /v1/threads/messages` answers them.","example":{"threads":[{"threadId":"thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20","messages":[{"id":"msg_ZW1haWw6NDAyMjg0LjJAZXhhbXBsZS5jb20","threadId":"thr_ZW1haWw6NDAyMjg0LjFAZXhhbXBsZS5jb20","channel":"email","kind":"message","direction":"inbound","subject":"Re: Onboarding new engineers at Northwind Labs","body":"Thanks Alex, this is timely. We are hiring 12 engineers this quarter. Could we talk Thursday afternoon?\n\nAmanda\n\nOn Tue, Oct 13, 2026 at 9:04 AM Alex Rivera <alex@mail.example.com> wrote:\n> Hi Amanda, following up on this.","extractedText":"Thanks Alex, this is timely. We are hiring 12 engineers this quarter. Could we talk Thursday afternoon?","language":"en","occurredAt":"2026-10-13T16:22:05Z","senderName":"Amanda Chen","fromName":"Amanda Chen","fromEmailAddress":"amanda.chen@northwind.example.com","tags":[{"id":341,"name":"Hot lead","color":"#FFD6A5"}],"to":[{"name":"Alex Rivera","address":"alex@mail.example.com"}]}]}],"failed":[{"id":"thr_ZW1haWw6NDAyMzE3LjFAZXhhbXBsZS5jb20","error":{"code":"not_found","message":"Thread was not found."}}]}},"ThreadMessagesBatchResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ThreadMessagesBatch"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadMessagesError":{"type":"object","properties":{"code":{"type":"string","description":"`not_found`: the id is malformed, or no thread in this workspace has it. `validation_failed`: the\nthread is not an email thread (detail code `channel_not_supported`); read it with\n`GET /v1/threads/{threadId}/messages`."},"message":{"type":"string","description":"A readable explanation."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"What failed: the item's `field` and detail `code`. Omitted when the failure has no detail.","nullable":true}},"additionalProperties":false,"description":"Why one thread in a batch read was not returned."},"ThreadMessagesFailure":{"type":"object","properties":{"id":{"type":"string","description":"The id as you sent it."},"error":{"allOf":[{"$ref":"#/components/schemas/ThreadMessagesError"}],"description":"Why the thread was not read."}},"additionalProperties":false,"description":"A thread a batch read did not return."},"ThreadRecipient":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Null when the email gives none.","nullable":true},"address":{"type":"string","description":"The email address.","nullable":true}},"additionalProperties":false,"description":"An email recipient."},"ThreadReferral":{"type":"object","properties":{"name":{"type":"string","description":"The person's name.","nullable":true},"email":{"type":"string","description":"The person's email address.","nullable":true},"linkedinUrl":{"type":"string","description":"The person's LinkedIn profile URL.","nullable":true},"phone":{"type":"string","description":"The person's phone number as the reply writes it. Kenso cannot add a person with only a phone number as a\ncontact, so add them by hand.","nullable":true}},"additionalProperties":false,"description":"The person a recruiting reply referred you to, when its interest is `referral`. Every part comes from the reply\nitself, and a part the reply does not give is null."},"ThreadResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Thread"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ThreadTag":{"type":"object","properties":{"id":{"type":"integer","description":"The tag's id.","format":"int64"},"name":{"type":"string","description":"The tag's name.","nullable":true},"color":{"type":"string","description":"The tag's display color.","nullable":true},"systemKey":{"type":"string","description":"Set on a built-in Kenso tag: a fixed key to find it by, which stays the same when its name changes. Null on the\nworkspace's own tags.","nullable":true}},"additionalProperties":false,"description":"A tag on a thread or message."},"ThreadVoiceNoteInProgress":{"type":"object","properties":{"id":{"type":"integer","description":"The voice note's id.","format":"int64"},"status":{"type":"string","description":"Its status: `generating` while it is being made."},"createdByMemberId":{"type":"integer","description":"The member who asked for it, as their member id. Omitted for a note an API key with no member asked for.","format":"int64","nullable":true}},"additionalProperties":false,"description":"A voice note being made for an iMessage thread."},"ThreadVoiceNoteReady":{"type":"object","properties":{"voiceNoteId":{"type":"integer","description":"The voice note's id: send it as the `voiceNoteId` of a reply, or read it with `GET /v1/voice-notes/{voiceNoteId}`.","format":"int64"},"createdAt":{"type":"string","description":"When the note was asked for.","format":"date-time"},"createdByMemberId":{"type":"integer","description":"The member who asked for it, as their member id. Omitted for a note an API key with no member asked for.","format":"int64","nullable":true},"durationMs":{"type":"integer","description":"The note's length in milliseconds. Omitted when it was not measured.","format":"int32","nullable":true}},"additionalProperties":false,"description":"A ready voice note made for an iMessage thread and not sent yet."},"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."},"UpdateThreadBody":{"type":"object","properties":{"isRead":{"type":"boolean","description":"True marks the thread read, false unread. Null is refused."},"isArchived":{"type":"boolean","description":"True archives the thread, false moves it back to the inbox. Archiving an email thread archives every reply in it.\nNull is refused."},"isSaved":{"type":"boolean","description":"True saves the thread, false takes it out of the saved threads. Null is refused."},"interest":{"type":"string","description":"The label: `interested`, `not_interested`, `negative`, `automated`, `unclassified`,\n`unsubscribe`, `objection`, `wrong_contact`, `referral` or `out_of_office`.\n`not_interested` reads back as `negative`, and a LinkedIn thread does not take `automated`. On an\nemail thread, any value but `automated`, `out_of_office` and `unclassified` marks the reply as\nwritten by a person and stops the contact's sequence. Null is refused."},"reminderAt":{"type":"string","description":"When to remind you, as an ISO 8601 instant. Null clears the reminder.","format":"date-time","nullable":true},"personId":{"type":"integer","description":"Links the thread's contact to this person in Accounts, replacing any earlier link. A merged person links as the\nperson it merged into. Needs the `unified_inbox` feature on the workspace and Accounts edit. Null is refused.","format":"int64"}},"additionalProperties":false,"description":"The fields to change on a thread: at least one of them. A field not listed here is refused, and a Facebook thread\ntakes `isRead` only.","example":{"isRead":true,"isArchived":false,"isSaved":true,"interest":"interested","reminderAt":"2026-10-15T18:30:00Z","personId":77310}},"UpsertThreadDraftRequest":{"type":"object","properties":{"subject":{"type":"string","description":"Email only: the draft's subject. A LinkedIn thread ignores it.","nullable":true},"body":{"type":"string","description":"The draft's text. Empty or omitted deletes the draft.","nullable":true},"authorSource":{"type":"string","description":"Email only, optional: `agent` when a person saves a reply Ken wrote into their composer. The draft stays the\nperson's (the response's `authorSource` is `user`) and records the text as Ken's, with the model the\n`X-Ken-Generator` header names. Ignored for any caller that is not a person signed in to the Kenso app, and for\nany other value.","nullable":true}},"additionalProperties":false,"description":"A reply draft for a thread.","example":{"subject":"Re: Onboarding new engineers at Northwind Labs","body":"<p>Hi Amanda,</p><p>Thursday works. Does 2pm Central suit you? I will send an invite.</p><p>Alex</p>"}},"VoiceNoteRef":{"type":"object","properties":{"voiceNoteId":{"type":"integer","description":"The voice note's id. 0 for a voice note a contact sent.","format":"int64"},"status":{"type":"string","description":"`pending`, `generating`, `ready`, `sent`, `failed` or `expired`. On a thread\nmessage, a contact's note reads `received`."},"durationMs":{"type":"integer","description":"The audio's length in milliseconds. Null until known.","format":"int32","nullable":true},"language":{"type":"string","description":"The language of the script. Null when unknown.","nullable":true},"provider":{"type":"string","description":"The voice service that made the audio. Null when unknown.","nullable":true},"voiceId":{"type":"string","description":"The voice used for the audio. Null when unknown.","nullable":true},"scriptText":{"type":"string","description":"The words spoken. Null until generated, and left out of list reads.","nullable":true},"failureReason":{"type":"string","description":"Why the voice note failed. Null unless status is `failed`.","nullable":true},"audioAvailable":{"type":"boolean","description":"True while Kenso keeps the audio."},"audioUrl":{"type":"string","description":"The API route that serves the audio. Null when the audio is gone.","nullable":true}},"additionalProperties":false,"description":"A LinkedIn voice note on a message, touch or account activity. `audioUrl` is an API route that redirects to a\nshort-lived link to the audio, and is set only while Kenso keeps the audio."}}}}