{"openapi":"3.0.4","info":{"title":"Kenso API: Credits","version":"1.1","description":"The Credits 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":"credits","description":"Credits pay for work in Kenso, such as finding emails, AI qualification and personalization, campaign builds, and\nKenso inboxes, domains and LinkedIn accounts. Every amount in this section is in millicredits: 1 credit\nis 1,000 millicredits and costs $0.02. Read the balance and estimate a job before you start it, then read the ledger\nto see where the credits went. A white-label client workspace shares its parent workspace's balance.","x-displayName":"Credits"}],"paths":{"/v1/credits":{"get":{"tags":["credits"],"summary":"Get the credit balance","description":"Returns the workspace's credit balance: what is left, what data and AI work can spend now, the plan's included\nsends and free builds, and any bonus credits or launch offer. A white-label client workspace sees its parent\nworkspace's shared balance.\n            \nA member without the `billing` permission gets the response without its billing details:\n`includedMillicredits`, `purchasedMillicredits`, `debtMillicredits`,\n`reservedMonthlyMillicredits`, `includedExpiresAt`, `grandfatheredUntil`, `autoTopUp`,\n`reservedItems`, `pendingCreditPurchases` and `unpaidRenewals`.\n            \n`smtpSending` is present while SMTP inboxes are billed per email: `millicreditsPerEmail` is the price of\none campaign email sent from such an inbox, `inboxesPerDomain`, `startDailyLimit`, `dailyStep` and\n`maxDailyLimit` are the limits of an SMTP inbox, and `paused` is true while the workspace has an SMTP\ndomain billed per email and the credits it bought cannot pay for one email: those sends wait until credits are\nbought (a plan's included credits and bonus or free credits do not pay for SMTP emails), while\nGoogle and Outlook inboxes keep sending. Every member gets it. It is absent otherwise.\n            \nOpen to any workspace member.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"credits.get","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"}}],"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/CreditBalanceResponse"}}}},"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":"workspace_member","summary":"Any workspace member except a Network member"},"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."},"CreditAiLimit":{"type":"object","properties":{"percentUsed":{"type":"integer","description":"Percent of the AI limit used, 0-100: this month's, or the one-time allowance on Kenso Lifetime.","format":"int32"},"state":{"type":"string","description":"`ok`, `warning` (from 80%) or `reached`."}},"additionalProperties":false,"description":"The AI limit as a percent and state."},"CreditAutoTopUp":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the rule is on."},"thresholdCredits":{"type":"integer","description":"Kenso buys a pack when available credits drop below this many whole credits.","format":"int32"},"packCredits":{"type":"integer","description":"Credits each top-up buys, a multiple of 1,000.","format":"int32"},"lastError":{"type":"string","description":"Why the last automatic purchase failed. Omitted when it did not fail.","nullable":true}},"additionalProperties":false,"description":"An opt-in rule that buys a credit pack when available credits drop below a threshold."},"CreditBalance":{"type":"object","properties":{"object":{"type":"string","description":"Always `credit_balance`."},"balanceMillicredits":{"type":"integer","description":"The credits left minus any debt.","format":"int64"},"includedMillicredits":{"type":"integer","description":"Included plan credits left, which expire. A billing detail.","format":"int64","nullable":true},"purchasedMillicredits":{"type":"integer","description":"Purchased, granted and other credits that do not expire. A billing detail.","format":"int64","nullable":true},"bonusMillicredits":{"type":"integer","description":"Bonus credits left from a credit promotion. Kenso spends them before the included credits, they expire\n            at the end of their billing month, and they cannot pay for Kenso inboxes, domains or iMessage lines unless the workspace\n            is exempt or Kenso staff allowed its free credits for them.","format":"int64"},"bonusExpiresAt":{"type":"string","description":"When the earliest bonus credits left expire. Omitted when none are left.","format":"date-time","nullable":true},"bonusPromotion":{"allOf":[{"$ref":"#/components/schemas/CreditBonusPromotion"}],"description":"The workspace's running credit promotion. Omitted when it has none or the promotion ended."},"debtMillicredits":{"type":"integer","description":"Usage that no credits covered yet. The next credits added repay it first. A billing detail.","format":"int64","nullable":true},"reservedMonthlyMillicredits":{"type":"integer","description":"The monthly cost of active monthly items, such as Kenso inboxes, domains, LinkedIn accounts and iMessage\n            lines, held back for their renewals. A billing detail.","format":"int64","nullable":true},"availableMillicredits":{"type":"integer","description":"What data and AI work can spend now: the balance minus `reservedMonthlyMillicredits`.","format":"int64"},"inboxDomainEligibleMillicredits":{"type":"integer","description":"What can pay for Kenso inboxes, domains and iMessage lines: the balance minus free and bonus credits, which cannot.\n            Equal to the balance when the workspace is exempt or Kenso allowed its free credits for them.","format":"int64"},"freeMillicredits":{"type":"integer","description":"Free credits left: signup, bonus, Kenso-granted free credits and rewards. They count in the balance and pay\n            for data, AI and sending, but cannot pay for Kenso inboxes, domains or iMessage lines unless the workspace is exempt or\n            Kenso staff allowed its free credits for them. Includes `bonusMillicredits`.","format":"int64"},"includedExpiresAt":{"type":"string","description":"When the earliest included credits left expire. Omitted when none are left. A billing detail.","format":"date-time","nullable":true},"monthlyIncludedCredits":{"type":"integer","description":"Credits the plan grants each billing month.","format":"int32"},"usdPerCredit":{"type":"string","description":"The price of one credit in US dollars, as a string such as `\"0.02\"`."},"exempt":{"type":"boolean","description":"True when Kenso records costs on the ledger but never charges them."},"creditState":{"type":"string","description":"The balance state: `healthy`, `low` under 500 available credits, or `out` when data and AI work\ncannot start because nothing is available or a white-label client workspace hit its cap. Sending and warmup keep\nrunning, and an exempt workspace is always `healthy`."},"exhaustedAt":{"type":"string","description":"When available credits last dropped to zero or below. Omitted while credits are available.","format":"date-time","nullable":true},"grandfatheredUntil":{"type":"string","description":"Until when an older plan keeps its earlier allowance. Omitted otherwise. A billing detail.","format":"date-time","nullable":true},"sends":{"allOf":[{"$ref":"#/components/schemas/CreditSends"}],"description":"Included sends this billing month."},"builds":{"allOf":[{"$ref":"#/components/schemas/CreditBuilds"}],"description":"Free campaign builds this billing month."},"autoTopUp":{"allOf":[{"$ref":"#/components/schemas/CreditAutoTopUp"}],"description":"The rule that buys credits when they run low. A billing detail."},"reservedItems":{"type":"array","items":{"$ref":"#/components/schemas/CreditReservedItem"},"description":"Active monthly items, such as Kenso inboxes, by credit action. A billing detail.","nullable":true},"pendingCreditPurchases":{"type":"array","items":{"$ref":"#/components/schemas/CreditPendingPurchase"},"description":"Bank debit purchases still processing, oldest first. Kenso adds their credits when the payment clears.\n            A billing detail.","nullable":true},"unpaidRenewals":{"type":"array","items":{"$ref":"#/components/schemas/CreditUnpaidRenewal"},"description":"Monthly items, such as Kenso inboxes, domains, LinkedIn accounts and iMessage lines, whose renewal went\n            unpaid, oldest first. A billing detail.","nullable":true},"launchOffer":{"allOf":[{"$ref":"#/components/schemas/CreditLaunchOffer"}],"description":"The launch offer of a paid, non-exempt workspace while its window is open: email finding and profile\n            enrichment cost no credits until `endsAt`, up to `limit` lookups. Omitted otherwise."},"smtpSending":{"allOf":[{"$ref":"#/components/schemas/CreditSmtpSending"}],"description":"SMTP inboxes billed per email: what one campaign email costs, the limits of such an inbox, and whether\n            sending from them is paused because the credits the workspace bought cannot pay for one email. Omitted while\n            per-email SMTP billing is off."},"aiLimit":{"allOf":[{"$ref":"#/components/schemas/CreditAiLimit"}],"description":"The AI limit while the workspace is on the new pricing with the AI limit enforced; omitted\n            otherwise. Percent and state only, never dollars."}},"additionalProperties":false,"description":"The workspace's credit balance, in millicredits: 1 credit is 1,000 millicredits and costs $0.02. Billing details\nappear only for a caller with the `billing` permission."},"CreditBalanceResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/CreditBalance"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"CreditBonusPromotion":{"type":"object","properties":{"code":{"type":"string","description":"The offer code in uppercase, such as `EWOR`."},"monthlyCredits":{"type":"integer","description":"The whole bonus credits the promotion grants each billing month.","format":"int32"},"endsAt":{"type":"string","description":"When the promotion ends, in UTC. The end is exclusive: a billing month that starts at or after it gets\n            no bonus credits.","format":"date-time"}},"additionalProperties":false,"description":"A running credit promotion: `monthlyCredits` bonus credits each billing month that starts before\n            `endsAt`, on top of the plan's included credits."},"CreditBuilds":{"type":"object","properties":{"freeRemainingThisPeriod":{"type":"integer","description":"Free campaign builds left this billing month. A paid plan gets one a month.","format":"int32"},"overrunAvailable":{"type":"boolean","description":"Whether a build that runs out of credits can still finish, once a billing month."}},"additionalProperties":false,"description":"Free campaign builds this billing month."},"CreditLaunchOffer":{"type":"object","properties":{"startsAt":{"type":"string","description":"When the offer starts, in UTC.","format":"date-time"},"endsAt":{"type":"string","description":"When the offer ends, in UTC, exclusive: the last free day is the UTC day before.","format":"date-time"},"used":{"type":"integer","description":"Lookups the offer counted in the window, found or not.","format":"int32"},"limit":{"type":"integer","description":"The fair use limit: free lookups for the whole window.","format":"int32"},"stoppedAt":{"type":"string","description":"When the workspace reached the limit and the offer stopped for it. Omitted while the offer runs.","format":"date-time","nullable":true},"stoppedReason":{"type":"string","description":"Why the offer stopped for this workspace: `fair_use`. Omitted while the offer runs.","nullable":true}},"additionalProperties":false,"description":"The launch offer's window and fair use."},"CreditPendingPurchase":{"type":"object","properties":{"credits":{"type":"integer","description":"Credits Kenso adds once the payment clears.","format":"int32"},"amountUsd":{"type":"number","description":"What the purchase charges, in US dollars.","format":"double"},"kind":{"type":"string","description":"What was bought: `auto_top_up` or `pack`. Expect new values."},"startedAt":{"type":"string","description":"When the payment started, in UTC.","format":"date-time"}},"additionalProperties":false,"description":"A credit purchase whose payment is still processing."},"CreditReservedItem":{"type":"object","properties":{"action":{"type":"string","description":"The credit action: `ken_inbox_monthly`, `azure_domain_monthly`, `smtp_domain_monthly`,\n            `smtp_inbox_domain_monthly`, `linkedin_account_monthly`, `imessage_line_monthly` or\n            `facebook_account_monthly`. Expect new values."},"count":{"type":"integer","description":"How many active items use this action.","format":"int32"},"monthlyMillicredits":{"type":"integer","description":"Their monthly cost, in millicredits.","format":"int64"},"nextRenewalAt":{"type":"string","description":"When the next of them renews, in UTC: the earliest date one of them is paid through. Earlier than now\n            while a charge for one of them is unpaid and Kenso retries it (`unpaidRenewals`). Omitted while their first\n            charge is still pending.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Active monthly items of one credit action and their monthly cost."},"CreditSends":{"type":"object","properties":{"includedPerPeriod":{"type":"integer","description":"Sends included each billing month. Omitted when unlimited.","format":"int32","nullable":true},"usedThisPeriod":{"type":"integer","description":"Sends used this billing month.","format":"int32"},"periodStart":{"type":"string","description":"When the current billing month started, in UTC.","format":"date-time"},"periodEnd":{"type":"string","description":"When the current billing month ends, in UTC.","format":"date-time"}},"additionalProperties":false,"description":"Included sends in the current billing month."},"CreditSmtpSending":{"type":"object","properties":{"millicreditsPerEmail":{"type":"integer","description":"Millicredits one campaign email from an SMTP inbox costs: 250 is 0.25 credits, $5 per 1,000 emails.","format":"int64"},"inboxesPerDomain":{"type":"integer","description":"Inboxes on one SMTP domain.","format":"int32"},"startDailyLimit":{"type":"integer","description":"Emails a day a new SMTP inbox starts at.","format":"int32"},"dailyStep":{"type":"integer","description":"Emails a day it gains on each day it sends.","format":"int32"},"maxDailyLimit":{"type":"integer","description":"Emails a day it reaches.","format":"int32"},"paused":{"type":"boolean","description":"True when the workspace has an SMTP domain billed per email and the credits it bought cannot pay for\n            one email: campaign sends from those inboxes wait until credits are bought. The credits a plan includes and bonus\n            or free credits do not pay for SMTP emails. Other inboxes keep sending."}},"additionalProperties":false,"description":"SMTP inboxes billed per campaign email. Warmup, seed tests, test sends and replies are free."},"CreditUnpaidRenewal":{"type":"object","properties":{"resourceType":{"type":"string","description":"The kind of item: `inbox`, `domain`, `linkedin_account` or `imessage_line`. Expect new values."},"count":{"type":"integer","description":"How many items of this kind went unpaid.","format":"int32"},"unpaidSince":{"type":"string","description":"When the renewal charge first failed for lack of credits, in UTC.","format":"date-time"},"deleteAfter":{"type":"string","description":"When Kenso may delete the items if still unpaid, usually 14 days after `unpaidSince`.","format":"date-time"}},"additionalProperties":false,"description":"Monthly items whose renewal went unpaid at the same time. Kenso retries every hour, so buying credits\n            pays it, and deletes items still unpaid at `deleteAfter`."},"ErrorAccount":{"type":"object","properties":{"accountId":{"type":"integer","description":"The account's id.","format":"int64"},"name":{"type":"string","description":"The account's name."},"stakeholderId":{"type":"integer","description":"The person's stakeholder id on this account.","format":"int64"}},"additionalProperties":false,"description":"An account named in an error detail."},"ErrorBody":{"type":"object","properties":{"code":{"type":"string","description":"Stable error code, such as `validation_failed` or `not_found`. Branch on this value."},"message":{"type":"string","description":"A sentence for people that explains the error. It can change, so do not parse it."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"One entry per problem, naming the field or limit it is about. Omitted when there are none.","nullable":true},"requestId":{"type":"string","description":"The id of this request: the same value as the `X-Correlation-Id` response header. Quote it when you write\nto contact@ken.so."},"docUrl":{"type":"string","description":"The page on this code in the developer docs, which says what it means and how to fix it. The errors guide for a\ncode that has no page of its own.","readOnly":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"On a `402`, the plan rule or usage limit that refused the request and how to lift it. Omitted otherwise."},"impact":{"allOf":[{"$ref":"#/components/schemas/InvalidationImpact"}],"description":"On a `409` that refuses a change because it would clear stored AI output (a prompt edit, a restore or a\nreset), how much the change would clear. Omitted otherwise."},"surface":{"type":"string","description":"Set only by the voice ticket's `409` (code `voice_conversation_active`): the chat the person's other\nvoice conversation runs in, `support`, `ken` or `onboarding`. Omitted on every other error.","nullable":true}},"additionalProperties":false,"description":"What went wrong in a request."},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The request field, header or limit the problem is about, such as `name` or `Ken-Version`."},"code":{"type":"string","description":"Stable code for this problem, such as `required` or `invalid`."},"message":{"type":"string","description":"A sentence for people that explains this problem."},"count":{"type":"integer","description":"On `export_limit_exceeded`, how many rows match the export. Omitted otherwise.","format":"int32","nullable":true},"index":{"type":"integer","description":"The position of the refused item in the request's list. Omitted otherwise.","format":"int32","nullable":true},"limit":{"type":"integer","description":"On `export_limit_exceeded`, the row limit the export ran with. On a `quota_exceeded` detail whose\n`field` names a quota, that quota's limit. On a `rate_limited` detail from your workspace's rate\nlimits, the limit that was hit. Omitted otherwise.","format":"int32","nullable":true},"resetAt":{"type":"string","description":"On some `quota_exceeded` details, when the quota frees up, in UTC. It is the same instant as the top-level\n`quotaResetAt`. On a `rate_limited` detail from your workspace's rate limits, when that limit resets.\nOmitted otherwise.","format":"date-time","nullable":true},"retryAfterSeconds":{"type":"integer","description":"On those `quota_exceeded` details and on most `rate_limited` details, the seconds to wait. It is the\nsame value as the `Retry-After` header. Omitted otherwise.","format":"int32","nullable":true},"inboxId":{"type":"integer","description":"The inbox the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainId":{"type":"integer","description":"The domain the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The name of that domain, or the domain name the request gave. Omitted otherwise.","nullable":true},"accountId":{"type":"integer","description":"On `domain_taken`, `already_stakeholder` and `previously_removed`, the existing account to use\ninstead. Omitted otherwise.","format":"int64","nullable":true},"personId":{"type":"integer","description":"On `email_taken` and `linkedin_url_taken`, the existing person to use instead. Omitted otherwise.","format":"int64","nullable":true},"stakeholderId":{"type":"integer","description":"The account stakeholder the problem is about. Omitted otherwise.","format":"int64","nullable":true},"championId":{"type":"integer","description":"Not used. Always omitted.","format":"int64","nullable":true},"callTaskId":{"type":"integer","description":"On `call_task_exists`, the open call task that already holds the person's slot. Omitted otherwise.","format":"int64","nullable":true},"status":{"type":"string","description":"On `invalid_transition`, the current status. Omitted otherwise.","nullable":true},"allowed":{"type":"array","items":{"type":"string"},"description":"On `out_of_range`, the allowed values. On `invalid_transition`, the statuses the change is allowed\nfrom. Omitted otherwise.","nullable":true},"scope":{"type":"string","description":"On a `permission_denied` for an account owner change, the account scope the call needs (`all`). On\n`sending_paused`, what the pause covers: `inbox`, `domain` or `workspace`. Omitted otherwise.","nullable":true},"removedAt":{"type":"string","description":"On `previously_removed`, when a person removed the stakeholder, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"page":{"type":"string","description":"On `permission_denied`, the page the call needs, such as `campaigns`. Omitted otherwise.","nullable":true},"required":{"type":"string","description":"On `permission_denied`, the access `page` needs: `view` or `edit`. Omitted otherwise.","nullable":true},"feature":{"type":"string","description":"On `permission_denied`, the permission the call needs, such as `launch`. Omitted otherwise.","nullable":true},"runId":{"type":"integer","description":"On `committee_run_active` and `run_not_finding`, the committee run the problem is about. Omitted\notherwise.","format":"int64","nullable":true},"mergedIntoId":{"type":"integer","description":"On `person_merged`, the person the merged person now lives on. On `account_merged`, the account the\nmerged account now lives on. Omitted otherwise.","format":"int64","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAccount"},"description":"On `person_on_accounts`, the accounts that block the change. Omitted otherwise.","nullable":true},"stage":{"type":"string","description":"On `stage_in_use` and `system_stage`, the opportunity stage key the problem is about. Omitted otherwise.","nullable":true},"opportunityCount":{"type":"integer","description":"On `stage_in_use`, how many opportunities are in that stage. Omitted otherwise.","format":"int32","nullable":true},"rule":{"type":"string","description":"On `guardrail_violation`, the contact limit rule the change breaks. Omitted otherwise.","nullable":true},"nextAllowedAt":{"type":"string","description":"On `guardrail_violation`, the first `dueAt` that passes every contact limit, in UTC. On a refused\nsend, when to retry. Omitted otherwise, and when waiting does not clear it.","format":"date-time","nullable":true},"fix":{"type":"string","description":"On a refused send, what to do next, in plain words. Omitted otherwise.","nullable":true},"opensAt":{"type":"string","description":"On `outside_calling_hours`, when the person's calling window opens, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"On a knowledge file's `version_conflict`, the file's current version. Omitted otherwise.","format":"int32","nullable":true},"provider":{"type":"string","description":"On a CRM connection error (`provider_error`, `exchange_failed`, `already_connected`,\n`account_mismatch` or `provider_unavailable`), the CRM it is about. Omitted otherwise.","nullable":true},"sharedWithMaster":{"type":"boolean","description":"True on a `quota_exceeded` detail when the shared limit of the white-label master workspace was hit, so\n`limit` is the limit of the whole white-label account. Omitted otherwise. The master's id is never sent.","nullable":true},"stepId":{"type":"integer","description":"On `link_reputation_blocked`, the saved sequence step that holds the blocked link. Omitted otherwise, and\nfor a step the save would have created.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"On `link_reputation_blocked`, the `stepOrder` of that step. Omitted otherwise.","format":"int32","nullable":true},"url":{"type":"string","description":"On `link_reputation_blocked`, the blocked link as the step's copy writes it. Omitted otherwise.","nullable":true},"key":{"type":"string","description":"On `unfilled_template_key`, the template key the text still holds, such as `first_name` for\n`{first_name}`. Omitted otherwise.","nullable":true},"marker":{"type":"string","description":"On `unfilled_template_key`, that key as the text writes it, such as `{first_name}` or `[company]`.\nOmitted otherwise.","nullable":true},"retryAt":{"type":"string","description":"On a warm path Start's `guardrail_connector_monthly`, `guardrail_account_monthly`,\n`guardrail_connector_cooldown` and `guardrail_handoff_weekly`, when the limit frees up, in UTC. Omitted\notherwise.","format":"date-time","nullable":true},"workspaceId":{"type":"integer","description":"On `last_admin`, a workspace that needs a new admin before the account can be deleted. On\n`new_admin_not_found`, the workspace of the refused choice. Omitted otherwise.","format":"int64","nullable":true},"workspaceName":{"type":"string","description":"On `last_admin`, the name of that workspace. Omitted otherwise.","nullable":true},"class":{"type":"string","description":"On a `rate_limited` detail from your workspace's rate limits, the class of call that hit its limit:\n`read`, `write`, `bulk`, `heavy` or `sensitive`. Omitted otherwise.","nullable":true},"window":{"type":"string","description":"On that detail, the window whose limit was hit: `minute`, `day` or `bulkItemsDay`. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One problem in an error: the field or limit it is about, a stable `code` and a `message`. The other fields\nappear only with the codes their descriptions name."},"Failure":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on an error."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"What went wrong."},"quotaResetAt":{"type":"string","description":"When the quota that refused the request frees up, in UTC. Set on some quota refusals. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"The current revision of a workflow draft, on a draft save's `409 version_conflict`. Read the workflow\nagain, then send this value as `baseVersion`. Omitted otherwise.","format":"int32","nullable":true},"current":{"allOf":[{"$ref":"#/components/schemas/MeetingRepNotesCurrent"}],"description":"Your meeting notes and their version as stored now, on a meeting notes save's `409 version_conflict`.\nMerge your change, then save again with `baseVersion` set to `current.repNotesVersion`. Omitted\notherwise."},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"A copy of `error.refusal`, set on some billing refusals. Omitted otherwise."},"message":{"type":"string","description":"A copy of `error.message`, set together with `refusal`. Omitted otherwise.","nullable":true},"lookalikeSeeds":{"description":"How Kenso read each seed of a lookalike search, on its `422 no_usable_seeds`:\n`{resolved: [{input, companyId, personId, name, domain}], unresolved: [{input, reason}]}`. Use it to show\nwhy no seed was usable. Omitted otherwise."}},"additionalProperties":false,"description":"The body of every error, with a 4xx or 5xx status. Branch on `error.code`."},"InvalidationImpact":{"type":"object","properties":{"qualificationResponses":{"type":"integer","description":"Stored qualification answers the change would clear.","format":"int32"},"qualifiedFlags":{"type":"integer","description":"Contacts whose qualified result the change would clear.","format":"int32"},"segmentationReasoning":{"type":"integer","description":"Stored segmentation explanations the change would clear.","format":"int32"},"segmentationAssignmentsKept":{"type":"integer","description":"Contacts that keep their segment.","format":"int32"},"segmentationAssignmentsReset":{"type":"integer","description":"Contacts that go back to the default segment.","format":"int32"},"personalizationLines":{"type":"integer","description":"Personalized lines the change would clear.","format":"int32"},"personalizationLeads":{"type":"integer","description":"Contacts that would lose their personalized lines.","format":"int32"},"rewritingLines":{"type":"integer","description":"Rewritten lines the change would clear.","format":"int32"},"rewritingLeads":{"type":"integer","description":"Contacts that would lose their rewritten lines.","format":"int32"}},"additionalProperties":false,"description":"How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it\nkeeps or resets."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"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."}}}}