{"openapi":"3.0.4","info":{"title":"Kenso API: Market packs","version":"1.1","description":"The Market packs 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":"markets","description":"A market pack is Kenso's writing guide for one locale, such as `fr-FR`: formality, greetings, sign-offs, style\nrules, phrases to avoid and native examples. Each pack also lists the countries it writes for, with a short note on\nhow each country's law treats cold email. Use the packs to pick the languages a campaign turns on. The packs are the\nsame for every workspace, so these calls need no `X-Ken-Workspace-Id`.","x-displayName":"Market packs"}],"paths":{"/v1/markets":{"get":{"tags":["markets"],"summary":"List market packs","description":"Returns every market pack Kenso offers, ordered by locale. Use it to show the languages a campaign can turn on.\n            \nEach item has the pack's `locale`, `language`, `name`, `status` and the `countries` it\nwrites for. Read `GET /v1/markets/{locale}` for the whole pack. Page with `limit` and `cursor`: pass\n`nextCursor` as `cursor` to read the next page.\n            \nErrors:\n            \n- `400 validation_failed`: `limit` is not from 1 to 200, or `cursor` is not a cursor from this list.\n            \nOpen to any signed-in caller, including an API key limited to a permission template.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"markets.list","parameters":[{"name":"limit","in":"query","description":"Number of market packs per page, from 1 to 200, default 50.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"cursor","in":"query","description":"The `nextCursor` from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"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}}}],"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/MarketSummaryListResponse"}}}},"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"]},"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"]},"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":"authenticated","summary":"Any signed-in caller"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/markets/{locale}":{"get":{"tags":["markets"],"summary":"Get a market pack","description":"Returns one market pack in full, with the countries it writes for and each country's cold email rules. Use it to\nread the writing rules Kenso follows for a locale.\n            \n`locale` is a pack locale such as `fr-FR`, in any letter case and with `-` or `_`:\n`FR-fr` and `fr_FR` both read as `fr-FR`. `pack` holds the whole pack: formality, greetings,\nsign-offs, style, banned and spam phrases, and examples. `countries` lists the countries the pack writes for,\neach with its languages and `coldEmail`. `coldEmail.regime` is `opt_out`, `consent` or\n`unresolved`, and `coldEmail.requiresAcknowledgement` is true when a member must acknowledge the\ncountry's rules before a campaign with contacts there launches. Every cold email note ends with \"Not legal\nadvice.\"\n            \nErrors:\n            \n- `404 not_found`: no pack has this locale. A bare language such as `fr` is not a locale.\n            \nOpen to any signed-in caller, including an API key limited to a permission template.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"markets.get","parameters":[{"name":"locale","in":"path","description":"Locale of the pack, such as `fr-FR`.","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}}}],"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/MarketResponse"}}}},"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"]},"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":"authenticated","summary":"Any signed-in caller"},"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."},"ErrorAccount":{"type":"object","properties":{"accountId":{"type":"integer","description":"The account's id.","format":"int64"},"name":{"type":"string","description":"The account's name."},"stakeholderId":{"type":"integer","description":"The person's stakeholder id on this account.","format":"int64"}},"additionalProperties":false,"description":"An account named in an error detail."},"ErrorBody":{"type":"object","properties":{"code":{"type":"string","description":"Stable error code, such as `validation_failed` or `not_found`. Branch on this value."},"message":{"type":"string","description":"A sentence for people that explains the error. It can change, so do not parse it."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"One entry per problem, naming the field or limit it is about. Omitted when there are none.","nullable":true},"requestId":{"type":"string","description":"The id of this request: the same value as the `X-Correlation-Id` response header. Quote it when you write\nto contact@ken.so."},"docUrl":{"type":"string","description":"The page on this code in the developer docs, which says what it means and how to fix it. The errors guide for a\ncode that has no page of its own.","readOnly":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"On a `402`, the plan rule or usage limit that refused the request and how to lift it. Omitted otherwise."},"impact":{"allOf":[{"$ref":"#/components/schemas/InvalidationImpact"}],"description":"On a `409` that refuses a change because it would clear stored AI output (a prompt edit, a restore or a\nreset), how much the change would clear. Omitted otherwise."},"surface":{"type":"string","description":"Set only by the voice ticket's `409` (code `voice_conversation_active`): the chat the person's other\nvoice conversation runs in, `support`, `ken` or `onboarding`. Omitted on every other error.","nullable":true}},"additionalProperties":false,"description":"What went wrong in a request."},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The request field, header or limit the problem is about, such as `name` or `Ken-Version`."},"code":{"type":"string","description":"Stable code for this problem, such as `required` or `invalid`."},"message":{"type":"string","description":"A sentence for people that explains this problem."},"count":{"type":"integer","description":"On `export_limit_exceeded`, how many rows match the export. Omitted otherwise.","format":"int32","nullable":true},"index":{"type":"integer","description":"The position of the refused item in the request's list. Omitted otherwise.","format":"int32","nullable":true},"limit":{"type":"integer","description":"On `export_limit_exceeded`, the row limit the export ran with. On a `quota_exceeded` detail whose\n`field` names a quota, that quota's limit. On a `rate_limited` detail from your workspace's rate\nlimits, the limit that was hit. Omitted otherwise.","format":"int32","nullable":true},"resetAt":{"type":"string","description":"On some `quota_exceeded` details, when the quota frees up, in UTC. It is the same instant as the top-level\n`quotaResetAt`. On a `rate_limited` detail from your workspace's rate limits, when that limit resets.\nOmitted otherwise.","format":"date-time","nullable":true},"retryAfterSeconds":{"type":"integer","description":"On those `quota_exceeded` details and on most `rate_limited` details, the seconds to wait. It is the\nsame value as the `Retry-After` header. Omitted otherwise.","format":"int32","nullable":true},"inboxId":{"type":"integer","description":"The inbox the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainId":{"type":"integer","description":"The domain the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The name of that domain, or the domain name the request gave. Omitted otherwise.","nullable":true},"accountId":{"type":"integer","description":"On `domain_taken`, `already_stakeholder` and `previously_removed`, the existing account to use\ninstead. Omitted otherwise.","format":"int64","nullable":true},"personId":{"type":"integer","description":"On `email_taken` and `linkedin_url_taken`, the existing person to use instead. Omitted otherwise.","format":"int64","nullable":true},"stakeholderId":{"type":"integer","description":"The account stakeholder the problem is about. Omitted otherwise.","format":"int64","nullable":true},"championId":{"type":"integer","description":"Not used. Always omitted.","format":"int64","nullable":true},"callTaskId":{"type":"integer","description":"On `call_task_exists`, the open call task that already holds the person's slot. Omitted otherwise.","format":"int64","nullable":true},"status":{"type":"string","description":"On `invalid_transition`, the current status. Omitted otherwise.","nullable":true},"allowed":{"type":"array","items":{"type":"string"},"description":"On `out_of_range`, the allowed values. On `invalid_transition`, the statuses the change is allowed\nfrom. Omitted otherwise.","nullable":true},"scope":{"type":"string","description":"On a `permission_denied` for an account owner change, the account scope the call needs (`all`). On\n`sending_paused`, what the pause covers: `inbox`, `domain` or `workspace`. Omitted otherwise.","nullable":true},"removedAt":{"type":"string","description":"On `previously_removed`, when a person removed the stakeholder, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"page":{"type":"string","description":"On `permission_denied`, the page the call needs, such as `campaigns`. Omitted otherwise.","nullable":true},"required":{"type":"string","description":"On `permission_denied`, the access `page` needs: `view` or `edit`. Omitted otherwise.","nullable":true},"feature":{"type":"string","description":"On `permission_denied`, the permission the call needs, such as `launch`. Omitted otherwise.","nullable":true},"runId":{"type":"integer","description":"On `committee_run_active` and `run_not_finding`, the committee run the problem is about. Omitted\notherwise.","format":"int64","nullable":true},"mergedIntoId":{"type":"integer","description":"On `person_merged`, the person the merged person now lives on. On `account_merged`, the account the\nmerged account now lives on. Omitted otherwise.","format":"int64","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAccount"},"description":"On `person_on_accounts`, the accounts that block the change. Omitted otherwise.","nullable":true},"stage":{"type":"string","description":"On `stage_in_use` and `system_stage`, the opportunity stage key the problem is about. Omitted otherwise.","nullable":true},"opportunityCount":{"type":"integer","description":"On `stage_in_use`, how many opportunities are in that stage. Omitted otherwise.","format":"int32","nullable":true},"rule":{"type":"string","description":"On `guardrail_violation`, the contact limit rule the change breaks. Omitted otherwise.","nullable":true},"nextAllowedAt":{"type":"string","description":"On `guardrail_violation`, the first `dueAt` that passes every contact limit, in UTC. On a refused\nsend, when to retry. Omitted otherwise, and when waiting does not clear it.","format":"date-time","nullable":true},"fix":{"type":"string","description":"On a refused send, what to do next, in plain words. Omitted otherwise.","nullable":true},"opensAt":{"type":"string","description":"On `outside_calling_hours`, when the person's calling window opens, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"On a knowledge file's `version_conflict`, the file's current version. Omitted otherwise.","format":"int32","nullable":true},"provider":{"type":"string","description":"On a CRM connection error (`provider_error`, `exchange_failed`, `already_connected`,\n`account_mismatch` or `provider_unavailable`), the CRM it is about. Omitted otherwise.","nullable":true},"sharedWithMaster":{"type":"boolean","description":"True on a `quota_exceeded` detail when the shared limit of the white-label master workspace was hit, so\n`limit` is the limit of the whole white-label account. Omitted otherwise. The master's id is never sent.","nullable":true},"stepId":{"type":"integer","description":"On `link_reputation_blocked`, the saved sequence step that holds the blocked link. Omitted otherwise, and\nfor a step the save would have created.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"On `link_reputation_blocked`, the `stepOrder` of that step. Omitted otherwise.","format":"int32","nullable":true},"url":{"type":"string","description":"On `link_reputation_blocked`, the blocked link as the step's copy writes it. Omitted otherwise.","nullable":true},"key":{"type":"string","description":"On `unfilled_template_key`, the template key the text still holds, such as `first_name` for\n`{first_name}`. Omitted otherwise.","nullable":true},"marker":{"type":"string","description":"On `unfilled_template_key`, that key as the text writes it, such as `{first_name}` or `[company]`.\nOmitted otherwise.","nullable":true},"retryAt":{"type":"string","description":"On a warm path Start's `guardrail_connector_monthly`, `guardrail_account_monthly`,\n`guardrail_connector_cooldown` and `guardrail_handoff_weekly`, when the limit frees up, in UTC. Omitted\notherwise.","format":"date-time","nullable":true},"workspaceId":{"type":"integer","description":"On `last_admin`, a workspace that needs a new admin before the account can be deleted. On\n`new_admin_not_found`, the workspace of the refused choice. Omitted otherwise.","format":"int64","nullable":true},"workspaceName":{"type":"string","description":"On `last_admin`, the name of that workspace. Omitted otherwise.","nullable":true},"class":{"type":"string","description":"On a `rate_limited` detail from your workspace's rate limits, the class of call that hit its limit:\n`read`, `write`, `bulk`, `heavy` or `sensitive`. Omitted otherwise.","nullable":true},"window":{"type":"string","description":"On that detail, the window whose limit was hit: `minute`, `day` or `bulkItemsDay`. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One problem in an error: the field or limit it is about, a stable `code` and a `message`. The other fields\nappear only with the codes their descriptions name."},"Failure":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on an error."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"What went wrong."},"quotaResetAt":{"type":"string","description":"When the quota that refused the request frees up, in UTC. Set on some quota refusals. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"The current revision of a workflow draft, on a draft save's `409 version_conflict`. Read the workflow\nagain, then send this value as `baseVersion`. Omitted otherwise.","format":"int32","nullable":true},"current":{"allOf":[{"$ref":"#/components/schemas/MeetingRepNotesCurrent"}],"description":"Your meeting notes and their version as stored now, on a meeting notes save's `409 version_conflict`.\nMerge your change, then save again with `baseVersion` set to `current.repNotesVersion`. Omitted\notherwise."},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"A copy of `error.refusal`, set on some billing refusals. Omitted otherwise."},"message":{"type":"string","description":"A copy of `error.message`, set together with `refusal`. Omitted otherwise.","nullable":true},"lookalikeSeeds":{"description":"How Kenso read each seed of a lookalike search, on its `422 no_usable_seeds`:\n`{resolved: [{input, companyId, personId, name, domain}], unresolved: [{input, reason}]}`. Use it to show\nwhy no seed was usable. Omitted otherwise."}},"additionalProperties":false,"description":"The body of every error, with a 4xx or 5xx status. Branch on `error.code`."},"InvalidationImpact":{"type":"object","properties":{"qualificationResponses":{"type":"integer","description":"Stored qualification answers the change would clear.","format":"int32"},"qualifiedFlags":{"type":"integer","description":"Contacts whose qualified result the change would clear.","format":"int32"},"segmentationReasoning":{"type":"integer","description":"Stored segmentation explanations the change would clear.","format":"int32"},"segmentationAssignmentsKept":{"type":"integer","description":"Contacts that keep their segment.","format":"int32"},"segmentationAssignmentsReset":{"type":"integer","description":"Contacts that go back to the default segment.","format":"int32"},"personalizationLines":{"type":"integer","description":"Personalized lines the change would clear.","format":"int32"},"personalizationLeads":{"type":"integer","description":"Contacts that would lose their personalized lines.","format":"int32"},"rewritingLines":{"type":"integer","description":"Rewritten lines the change would clear.","format":"int32"},"rewritingLeads":{"type":"integer","description":"Contacts that would lose their rewritten lines.","format":"int32"}},"additionalProperties":false,"description":"How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it\nkeeps or resets."},"Market":{"required":["pack"],"type":"object","properties":{"locale":{"type":"string","description":"BCP 47 locale of the pack, such as `fr-FR`."},"language":{"type":"string","description":"ISO 639-1 code of the pack's language, such as `fr`."},"name":{"type":"string","description":"Name of the locale in its own language, such as `Français (France)`."},"status":{"allOf":[{"$ref":"#/components/schemas/MarketPackStatus"}],"description":"How far Kenso has checked the pack: `supported` when Kenso validated it for drafts a member reviews, or\n`tested` when it also passed Kenso's quality evaluation for messages sent without review."},"pack":{"allOf":[{"$ref":"#/components/schemas/MarketPack"}],"description":"The whole pack: formality, greetings, sign-offs, name order, style, banned and spam phrases, reply phrases and\nnative examples."},"countries":{"type":"array","items":{"$ref":"#/components/schemas/MarketCountry"},"description":"The countries the pack writes for, sorted by ISO code, each with its languages and cold email rules. Every cold\nemail note ends with \"Not legal advice.\""}},"additionalProperties":false,"description":"A market pack in full, with the countries it writes for."},"MarketColdEmailRegime":{"enum":["opt_out","consent","unresolved"],"type":"string","description":"Whether a country's law lets a sender email business contacts without prior consent. On the wire it is\n`opt_out`, `consent` or `unresolved`."},"MarketCountry":{"required":["coldEmail","iso2","languages","name"],"type":"object","properties":{"iso2":{"type":"string","description":"ISO 3166-1 alpha-2 code of the country, uppercase, such as `ES`."},"name":{"type":"string","description":"English name of the country, such as `Spain`."},"languages":{"type":"array","items":{"$ref":"#/components/schemas/MarketCountryLanguage"},"description":"Languages spoken in the country, largest share first, so the first official language is the main one."},"coldEmail":{"allOf":[{"$ref":"#/components/schemas/MarketCountryColdEmail"}],"description":"How the country's law treats cold email to business contacts."}},"additionalProperties":false,"description":"A country a market pack writes for: the languages spoken there and how its law treats cold email."},"MarketCountryColdEmail":{"type":"object","properties":{"regime":{"allOf":[{"$ref":"#/components/schemas/MarketColdEmailRegime"}],"description":"`opt_out`, `consent` or `unresolved`."},"note":{"type":"string","description":"A short summary of the rule, ending in \"Not legal advice.\""},"sources":{"type":"array","items":{"type":"string"},"description":"Links to the public pages the note is based on. At least one."},"requiresAcknowledgement":{"type":"boolean","description":"True when a member must acknowledge the country's rules before a campaign with contacts there launches."}},"additionalProperties":false,"description":"How a country's law treats cold email to business contacts."},"MarketCountryLanguage":{"type":"object","properties":{"code":{"type":"string","description":"ISO 639-1 code of the language, such as `es`. Always two letters."},"locale":{"type":"string","description":"The language as spoken in this country, such as `es-MX`."},"share":{"type":"number","description":"Share of the country's population that speaks it, from 0 to 1.","format":"double"},"official":{"type":"boolean","description":"True when the language is official in the country, de facto included, such as English in the United States."}},"additionalProperties":false,"description":"One language spoken in a country."},"MarketPack":{"required":["bannedPhrases","direction","examples","formality","language","locale","name","nameOrder","oooPhrases","optOutPhrases","primary","salutations","signOffs","spamPhrases","status","stopwords","style","text","version"],"type":"object","properties":{"locale":{"type":"string","description":"BCP 47 locale of the pack, such as `fr-FR`."},"language":{"type":"string","description":"ISO 639-1 code of the pack's language, the locale's prefix, such as `fr`."},"primary":{"type":"boolean","description":"True for the one pack per language that Kenso uses when only the language is known, such as `fr-FR` for `fr`."},"version":{"type":"string","description":"Version of the pack. A localization written with an older version reads as stale."},"status":{"allOf":[{"$ref":"#/components/schemas/MarketPackStatus"}],"description":"How far Kenso has checked the pack: `supported` or `tested`."},"name":{"type":"string","description":"Name of the locale in its own language, such as `Français (France)`."},"direction":{"type":"string","description":"Writing direction: `ltr` (left to right) or `rtl` (right to left)."},"formality":{"allOf":[{"$ref":"#/components/schemas/MarketPackFormality"}],"description":"The default register and the pronouns of each register."},"salutations":{"allOf":[{"$ref":"#/components/schemas/MarketPackSalutations"}],"description":"Greetings for formal and informal emails."},"signOffs":{"allOf":[{"$ref":"#/components/schemas/MarketPackSignOffs"}],"description":"Closing lines for formal and informal emails."},"nameOrder":{"type":"string","description":"Order of a person's names in this locale: `given-first` or `family-first`."},"style":{"type":"array","items":{"type":"string"},"description":"Writing guidance, in the pack's language."},"bannedPhrases":{"type":"array","items":{"type":"string"},"description":"Clichés and literal translations that a native reader dislikes."},"spamPhrases":{"type":"array","items":{"type":"string"},"description":"Phrases that read as spam in this language."},"stopwords":{"type":"array","items":{"type":"string"},"description":"Common lowercase words, letters only, that Kenso uses to detect the language of a text."},"text":{"allOf":[{"$ref":"#/components/schemas/MarketPackText"}],"description":"Fixed text in this language: the line above a quoted message, and the unsubscribe link and page."},"oooPhrases":{"type":"array","items":{"type":"string"},"description":"Phrases of out-of-office auto-replies, used to recognize them."},"optOutPhrases":{"type":"array","items":{"type":"string"},"description":"Phrases a contact uses to ask not to be contacted again."},"examples":{"type":"array","items":{"$ref":"#/components/schemas/MarketPackExample"},"description":"Native example emails, from 0 to 5. A tested pack has at least 3."},"eval":{"allOf":[{"$ref":"#/components/schemas/MarketPackEval"}],"description":"The evaluation that marked the pack tested. Omitted until then."}},"additionalProperties":false,"description":"Kenso's writing guide for one locale: the language rules that Kenso's writers, checks and reply handling share. Each\npack is written natively in its language, never translated from English."},"MarketPackEval":{"type":"object","properties":{"writerModel":{"type":"string","description":"The model that wrote the evaluation emails."},"judgeModels":{"type":"array","items":{"type":"string"},"description":"The one or two models that scored them, each from a different model family than the writer's."},"judgeThreshold":{"type":"number","description":"The score from 0 to 100 that an email must reach.","format":"double"},"testedAt":{"type":"string","description":"Date of the evaluation, as `yyyy-MM-dd`."},"results":{"type":"string","description":"Where Kenso keeps the evaluation results."}},"additionalProperties":false,"description":"The evaluation that marked a pack tested."},"MarketPackExample":{"type":"object","properties":{"subject":{"type":"string","description":"Subject of the example."},"body":{"type":"string","description":"Body of the example."}},"additionalProperties":false,"description":"One native example email."},"MarketPackFormality":{"type":"object","properties":{"default":{"type":"string","description":"The default register: `formal` or `informal`."},"pronouns":{"allOf":[{"$ref":"#/components/schemas/MarketPackPronouns"}],"description":"The pronouns of each register."}},"additionalProperties":false,"description":"The register a pack writes in by default, and the pronouns of each register."},"MarketPackPronouns":{"type":"object","properties":{"formal":{"type":"array","items":{"type":"string"},"description":"The pronouns of the formal register."},"informal":{"type":"array","items":{"type":"string"},"description":"The pronouns of the informal register."}},"additionalProperties":false,"description":"The second-person pronouns of the formal and the informal register, such as `vous` and `tu`."},"MarketPackSalutations":{"type":"object","properties":{"formal":{"type":"array","items":{"type":"string"},"description":"Greetings for formal emails."},"informal":{"type":"array","items":{"type":"string"},"description":"Greetings for informal emails."},"unknownGender":{"type":"string","description":"A formal greeting that needs no gender."}},"additionalProperties":false,"description":"Greetings for formal and informal emails. Each ends in `,` or `:` and may use only `{firstName}` and\n`{lastName}`."},"MarketPackSignOffs":{"type":"object","properties":{"formal":{"type":"array","items":{"type":"string"},"description":"Closing lines for formal emails."},"informal":{"type":"array","items":{"type":"string"},"description":"Closing lines for informal emails."}},"additionalProperties":false,"description":"Closing lines for formal and informal emails."},"MarketPackStatus":{"enum":["draft","supported","tested"],"type":"string","description":"How far Kenso has checked a market pack. On the wire it is `supported` or `tested`."},"MarketPackText":{"type":"object","properties":{"quoteLine":{"type":"string","description":"The line above a quoted message, with `{date}` and `{sender}`."},"quoteDate":{"type":"string","description":"The date format for `{date}`, as a .NET date format string."},"unsubscribeLink":{"type":"string","description":"Text of the unsubscribe link."},"unsubscribePageTitle":{"type":"string","description":"Title of the unsubscribe page."},"unsubscribePage":{"allOf":[{"$ref":"#/components/schemas/MarketPackUnsubscribePage"}],"description":"The words of the unsubscribe page. Omitted when the pack has none: the page is then in English."}},"additionalProperties":false,"description":"Fixed text Kenso uses in this language."},"MarketPackUnsubscribePage":{"type":"object","properties":{"confirmTitle":{"type":"string","description":"Title of the page that asks the contact to confirm."},"confirmBody":{"type":"string","description":"Text of the page that asks the contact to confirm."},"button":{"type":"string","description":"Label of the confirm button."},"doneTitle":{"type":"string","description":"Title of the page after the contact unsubscribed."},"doneBody":{"type":"string","description":"Text of the page after the contact unsubscribed."}},"additionalProperties":false,"description":"The words of the unsubscribe page, before and after the contact confirms. Both bodies name the address as `{email}`."},"MarketResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Market"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"MarketSummary":{"type":"object","properties":{"locale":{"type":"string","description":"BCP 47 locale of the pack, such as `fr-FR`."},"language":{"type":"string","description":"ISO 639-1 code of the pack's language, such as `fr`."},"name":{"type":"string","description":"Name of the locale in its own language, such as `Français (France)`."},"status":{"allOf":[{"$ref":"#/components/schemas/MarketPackStatus"}],"description":"How far Kenso has checked the pack: `supported` when Kenso validated it for drafts a member reviews, or\n`tested` when it also passed Kenso's quality evaluation for messages sent without review."},"countries":{"type":"array","items":{"type":"string"},"description":"ISO 3166-1 alpha-2 codes of the countries the pack writes for, sorted. A country is listed when one of its\nofficial languages uses this pack: the pack of that exact locale, or else the language's main pack."}},"additionalProperties":false,"description":"A market pack in the list."},"MarketSummaryListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/MarketSummary"},"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."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"Pagination":{"type":"object","properties":{"nextCursor":{"type":"string","description":"Send this value as `cursor` to get the next page. Omitted on the last page.","nullable":true},"hasMore":{"type":"boolean","description":"True when more items follow this page. Stop paging when it is false."},"total":{"type":"integer","description":"Deprecated: the same number as `totalCount`. Read `totalCount`.","format":"int32","nullable":true,"deprecated":true},"totalCount":{"type":"integer","description":"The number of items that match the list's filters, across all pages. Omitted when the list does not count them.","format":"int32","nullable":true},"isTotalCapped":{"type":"boolean","description":"True when `totalCount` stopped counting at its cap, so more items match than it says. Keep paging with\n`hasMore`. Omitted when `totalCount` is exact. Only `GET /v1/threads` with `q` caps its total.","nullable":true}},"additionalProperties":false,"description":"Where a list page ends and how to get the next page."},"RateLimitedText":{"type":"string","description":"The gateway's plain-text body of a `429` over the operation's own limit, until November 2026: `Number of requests exceeded. Please try again later.`","example":"Number of requests exceeded. Please try again later."},"Refusal":{"type":"object","properties":{"code":{"type":"string","description":"Stable refusal code in upper case, such as `CAMPAIGN_LIMIT_REACHED` or `INSUFFICIENT_CREDITS`."},"metric":{"type":"string","description":"What the limit counts: `Campaigns`, `Leads`, `Emails`, `LinkedInSeats` or `AiCredits`,\n`jobs_export_rows` or `funding_export_rows` for an export allowance, `credit_pack_credits`,\n`credit_spend_usd_7d`, `domains` or `mailboxes` for a limit on a new paying workspace, or for a\nKenso Lifetime cap its key: `workspaces`, `inboxes`, `contacts`, `email_verifications_day`,\n`email_verifications_month`, `people_results_day`, `company_results_day`,\n`funding_results_day`, `job_post_results_day`, `website_visits_month` or\n`visitor_lookups_day`. Omitted when a plan rule, not a count, refused the request.","nullable":true},"used":{"type":"integer","description":"How much of the limit is used, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"limit":{"type":"integer","description":"The limit, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"remaining":{"type":"integer","description":"How much of the limit is left, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"planType":{"type":"string","description":"The workspace's plan as its snake plan id, for example `free`, `legacy_core` or `growth`."},"remedy":{"type":"string","description":"What lifts the refusal: `Upgrade`, `BuyAddOn`, `UpdatePaymentMethod` or `ContactSupport`.\n`None` means no action of yours lifts it."},"unlocksAt":{"type":"string","description":"When the limit lifts by itself, in UTC: for a limit on a new paying workspace once it has paid an invoice, and for\na Kenso Lifetime daily or monthly cap its reset (00:00 UTC, or the 1st of the month). Omitted on every other\nrefusal.","format":"date-time","nullable":true},"requiredMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits the action needed. 1,000 millicredits are one credit. Omitted on every\nother refusal.","format":"int64","nullable":true},"availableMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits available. On `FREE_CREDITS_NOT_ELIGIBLE`, only the credits that may\npay for inboxes and domains. Omitted on every other refusal.","format":"int64","nullable":true},"restrictedMillicredits":{"type":"integer","description":"On `FREE_CREDITS_NOT_ELIGIBLE`, the free and bonus millicredits in the balance that cannot pay for inboxes\nand domains. Omitted on every other refusal.","format":"int64","nullable":true},"feature":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the plan feature the plan does not include, in snake case (for example\n`website_visitor_id`). Omitted on every other refusal.","nullable":true},"requiredPlan":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the cheapest plan that includes `feature`, in snake case (for example\n`growth`). For a feature the self-serve trial locks (`browser_runs`), the trial's own plan,\nwhich paying for unlocks it. Omitted on every other refusal.","nullable":true},"requiredTier":{"type":"integer","description":"On a Kenso Lifetime refusal, the lowest tier that lifts it: the next tier with a higher cap, or the lowest tier\nthat includes `feature`. Omitted at the top tier, when no tier includes the feature, and on every other\nrefusal.","format":"int32","nullable":true},"upgradeUrl":{"type":"string","description":"On a Kenso Lifetime refusal that a higher tier lifts, the AppSumo page where the buyer upgrades their license.\nOmitted until Kenso has read that page from AppSumo, when no tier lifts the refusal, and on every other refusal.","nullable":true}},"additionalProperties":false,"description":"Why a plan rule or usage limit refused the request, and how to lift it."},"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."}}}}