{"openapi":"3.0.4","info":{"title":"Kenso API: Campaigns","version":"1.1","description":"The Campaigns 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":"campaigns","description":"A campaign is one outbound program: its contacts, its email and LinkedIn steps, the inboxes and LinkedIn accounts it sends from, and its sending schedule. Create, set up and launch a campaign, then pause, resume, restart, archive or duplicate it; setup covers inboxes, LinkedIn, sender routing, AI workflows, lead scoring and enrichment, and reads cover launch readiness, processing status and a weekly report. Staff-tier Studio routes (flag `studio`) set the template a campaign's `{{asset_link}}` pages are built from and read their views.","x-displayName":"Campaigns"}],"paths":{"/v1/campaigns":{"get":{"tags":["campaigns"],"summary":"List campaigns","description":"Returns the workspace's campaigns, oldest first, archived ones included.\n            \n`status` filters by one or more statuses, comma-separated: `active`, `draft`, `building`,\n`ready`, `paused`, `completed`, `error` or `archived`. `kind` filters by\n`sales` or `recruiting`. `q` matches part of the campaign name or of the owner's name or email,\nignoring case. `createdAfter` (inclusive) and `createdBefore` (exclusive) keep the campaigns created in\nthat range. `sort=-createdAt` lists newest first and `sort=createdAt` oldest first; send the same\n`sort` on every page.\n            \nEach item's `leadCount` comes from a cached count that usually trails new or removed contacts by under 15\nminutes; `GET /v1/campaigns/{campaignId}` counts live. On a very large workspace `leadCount` can be\nomitted when the count does not finish in time. `linkedInOnly` appears only on this list. Each item's\n`readyLeadCount` is the last stored count: a list recounts launched campaigns whose count is over 10 minutes\nold in the background, and a campaign with no stored count omits it. With `includeTagIds=true` each item's\n`tagIds` lists the tags on the campaign; without it `tagIds` is omitted.\n            \nErrors:\n            \n- `400 validation_failed`: `status`, `kind`, `sort`, `limit` (1 to 200) or\n  `cursor` is invalid, a cursor comes from a page with another `sort`, or `createdBefore` is not\n  later than `createdAfter`.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.list","parameters":[{"name":"status","in":"query","description":"Only the campaigns in these statuses, as a comma-separated list of `active`, `draft`, `building`,\n`ready`, `paused`, `completed`, `error` and `archived`. Omit it for every status.","schema":{"type":"string"}},{"name":"q","in":"query","description":"Only the campaigns whose name contains this text, or whose owner's first name, last name, full name or email\ncontains it, ignoring case.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of campaigns 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":"kind","in":"query","description":"Only the campaigns of this kind: `sales` or `recruiting`. Omit it for both.","schema":{"type":"string"}},{"name":"includeTagIds","in":"query","description":"`true` adds each item's `tagIds`. Omit it to leave `tagIds` out.","schema":{"type":"boolean"}},{"name":"sort","in":"query","description":"The order: `createdAt` lists oldest first and `-createdAt` newest first. Omit it to list by id, oldest\nfirst. Send the same `sort` on every page.","schema":{"type":"string"}},{"name":"createdAfter","in":"query","description":"Only campaigns created at or after this time, in UTC.","schema":{"type":"string","format":"date-time"}},{"name":"createdBefore","in":"query","description":"Only campaigns created before this time, in UTC. Must be later than `createdAfter`.","schema":{"type":"string","format":"date-time"}},{"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/CampaignListResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"post":{"tags":["campaigns"],"summary":"Create a campaign","description":"Creates a campaign and returns it, with its URL in the `Location` header. Without a schedule it sends Monday\nto Friday, 10:00 to 18:00 New York time; change that with `PATCH /v1/campaigns/{campaignId}`.\n            \n`kind` is `sales` (the default) or `recruiting`. A sales campaign starts with\n`stopCompanyOnReply` and `groupSameCompanySends` on. A recruiting campaign needs the recruiting\nfeature, starts with both off and with same-company Cc off, and can name the role it hires for in\n`roleId`.\n            \n`source` says where in the app the campaign was started, for Kenso's product analytics: `builder`\n(the default) or `search`. It does not change the campaign, and a call with an API key or from an agent is\ncounted as such whatever it sends.\n            \nErrors:\n            \n- `400 validation_failed`: `name` is missing, `contactLimit` is not greater than 0, or\n  `kind` or `source` is unknown. Detail code `feature_disabled` means the workspace does not have\n  the recruiting feature, and `not_recruiting` means `roleId` was sent for a sales campaign.\n- `404 not_found`: `roleId` is not a role in this workspace.\n- `429 rate_limited`: the workspace created too many campaigns in a short time. Try again later.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.create","parameters":[{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignRequest"}}}},"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/CampaignResponse"}}}},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key","summary":"60 requests a minute and 500 a day per workspace (Free plan: 6 a minute and 50 a day)","quotas":[{"policy":"campaignCreate","per":"workspace","limits":[{"limit":60,"windowSeconds":60},{"limit":500,"windowSeconds":86400}],"plans":[{"plan":"Free","limits":[{"limit":6,"windowSeconds":60},{"limit":50,"windowSeconds":86400}]}]}]}}},"/v1/campaigns/{campaignId}":{"get":{"tags":["campaigns"],"summary":"Get a campaign","description":"Returns one campaign with its settings, sending progress and, while it is paused, why. `leadCount` is\ncounted live. `readyLeadCount` is counted live too, for up to 2 seconds, then the last stored count.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.get","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"patch":{"tags":["campaigns"],"summary":"Update a campaign","description":"Changes the fields you send and returns the campaign. Omitted fields stay as they are. A field the request body\ndoes not list, including `status` and `catchAllLanePausedAt`, is rejected; change the status with the\nlaunch, pause, resume, restart and archive actions.\n            \nKenso checks `replyTo`, `excludedCountries`, `bookingMeetingTypeId`, `roleId` and\n`mode` before it writes anything, so a refused value leaves the campaign unchanged. Schedule and daily\nlimit changes take effect from the next scheduling pass, within about 10 minutes. `excludedCountries`\napplies to imports right away and to contacts already in the campaign from the next sending pass.\n            \nSome fields need a workspace feature. Changing `stopOnReply`, `trackClicks` or `unsubscribeLink`\nneeds the campaign send settings feature; sending the current value is always accepted. `trackOpens` is\nalways false: campaign emails never carry an open-tracking pixel, so opens are not tracked and are never reported.\n`trackOpens` `true` is refused; `false` is accepted without the feature.\nThe language fields (`sourceLanguage`, `languageMode`, `enabledLanguages`,\n`formalityOverrides`, `languageFallback`) need the multilingual outreach feature, even to send the\ncurrent value. `roleId` needs the recruiting feature.\n            \n`sendAsPlainText` `true` sends the campaign's emails written as HTML as plain text only, from the next\nsend on, and needs no feature. Steps with a drawn handwritten letter, a video, a Studio email, a provider-built\nmessage or any image in the sent body (a signature logo counts) keep their HTML, decided per send. Turning\n`sendAsPlainText` on is refused while the campaign's sequence with conditions branches on an opened email.\n            \n`mode` `trigger` turns a batch campaign into a trigger campaign; the reverse is rejected. To make that\nswitch on a campaign set to launch by itself, send `autoLaunchWhenReady` `false` in the same request.\n`autoLaunchWhenReady` `true` launches the campaign once it is ready, with no further confirmation, so\nchanging it needs the `launch` permission.\n            \n`emailVerifiers` replaces the verifiers that check the campaign's emails. `zerobounce` and\n`neverbounce` run on the workspace's own key and spend its credits, never Kenso's; no campaign gets them\nunless it lists them.\n            \nErrors:\n            \n- `400 validation_failed`: a field is invalid, or a field the body does not list was sent. Detail codes\n  include `feature_disabled` (the workspace lacks the feature the field needs), `not_a_member`\n  (`ownerMemberId` is not an active member), `provider_key_missing` (`emailVerifiers` adds\n  `zerobounce` or `neverbounce` and the workspace has no working key for it), `kind_immutable` (`kind` was sent),\n  `not_recruiting` (`roleId` on a sales campaign), `invalid_country`, `unknown_language`,\n  `draft_language`, `invalid_value`, `mode_one_way` (trigger back to batch),\n  `open_tracking_off` (`sendAsPlainText` turned on while the sequence with conditions branches on an\n  opened email), `open_tracking_unavailable` (`trackOpens` `true`: opens are not tracked), and\n  `invalid`, `not_connected` or `not_ingested` for a `replyTo` that is not a connected\n  mailbox Kenso reads. `autoLaunchWhenReady` is also rejected once the campaign has launched, and on a\n  trigger or approval test campaign.\n- `402 plan_limit_reached`: the new `contactLimit` is more than the workspace's remaining lead\n  credits.\n- `403 forbidden`: `autoLaunchWhenReady` was changed without the `launch` permission.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 conflict`: `autoLaunchWhenReady` was changed after auto-launch already ran.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.update","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignRequest"}}}},"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/CampaignResponse"}}}},"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":["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":["conflict"]},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}},"delete":{"tags":["campaigns"],"summary":"Delete a campaign","description":"Deletes the campaign and its segments. A campaign that is sending is paused first, so nothing more is sent. The\ncampaign no longer appears in any list.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.delete","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/agent-work":{"get":{"tags":["campaigns"],"summary":"Get the campaign's agent work overrides","description":"Returns each kind a campaign can override (`personalization`) with the campaign's override (`executor`,\nnull when it follows the workspace) and the workspace's setting (`workspaceExecutor`).\n            \nErrors:\n            \n- `404 not_found`: the campaign is not in the workspace or is deleted, or the workspace does not have the\n  `agent_work` feature.\n            \nRequires Campaigns view. Not open to a Client seat.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `agent_work` feature on your workspace. Until it is on, calls answer 404.","operationId":"campaigns.get-agent-work","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignAgentWorkResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["agent_work"],"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"patch":{"tags":["campaigns"],"summary":"Update the campaign's agent work overrides","description":"Sets or clears the campaign's override of each kind you name. Body:\n`{ \"settings\": [ { \"kind\": \"personalization\", \"executor\": \"my_agent\" } ] }`. `executor` is\n`kenso_ai`, `my_agent`, or null to clear the override so the campaign follows its workspace. Returns the\ncampaign's overrides after the change, in the same shape as the GET. With `my_agent`, the campaign's\npersonalization waits for the workspace's agent (`kenso work run`) even when the workspace is on\n`kenso_ai`: Kenso's AI does not write it, and the full prompt and the lead's facts go to that agent. With\n`kenso_ai`, Kenso's AI writes it even when the workspace is on `my_agent`.\n            \nErrors:\n            \n- `400 validation_failed`: `settings` is missing or empty, a `kind` is not one a campaign can\n  override, an `executor` is not a known value, or a kind is named twice. Each problem is one\n  `details[]` entry, such as `settings[0].kind`. Nothing is saved.\n- `403 forbidden`: the caller is a workspace key. An override records the member who saves it, and a\n  workspace key is not a person.\n- `404 not_found`: the campaign is not in the workspace or is deleted, or the workspace does not have the\n  `agent_work` feature.\n            \nRequires Campaigns edit and the `workspace_settings` permission. Not open to a Client seat or an agent's run key.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `agent_work` feature on your workspace. Until it is on, calls answer 404.","operationId":"campaigns.update-agent-work","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignAgentWorkBody"}}}},"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/CampaignAgentWorkResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"403":{"description":"Forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["forbidden"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["agent_work"],"x-ken-permission":{"kind":"page","page":"campaigns","access":"edit","features":["workspace_settings"],"summary":"Campaigns edit and the `workspace_settings` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/archive":{"post":{"tags":["campaigns"],"summary":"Archive a campaign","description":"Sets the campaign's `status` to `archived` and returns it. Its queued emails are cancelled, so\nnothing sends while it is archived; its leads, replies and stats stay, Analytics keeps counting them, and its\nleads still count as duplicates for new campaigns. Archiving does not stop a sending campaign itself, so it is\nallowed only from `draft`, `paused` or `completed`: pause a sending campaign first. Undo with\n`POST /v1/campaigns/{campaignId}/unarchive`. Archiving an archived campaign changes nothing.\n            \nErrors:\n            \n- `400 validation_failed`: the campaign is not draft, paused or completed.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 invalid_state`: the campaign is sending or launching. Pause it first.\n            \nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.archive","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"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"]},"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":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/unarchive":{"post":{"tags":["campaigns"],"summary":"Unarchive a campaign","description":"Brings an archived campaign back and returns it. It never starts sending: a campaign archived after it finished\ncomes back `completed`, one that launched comes back `paused`, so call\n`POST /v1/campaigns/{campaignId}/resume` to send again, and one that never launched comes back a\n`draft`. Resume plans the sends that archiving cancelled. Unarchiving a campaign that is not archived\nchanges nothing.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 conflict`: the campaign changed while it was being unarchived. Try again.\n            \nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.unarchive","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"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"]},"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":["conflict"]},"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":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/bulk-pause":{"post":{"tags":["campaigns"],"summary":"Pause several campaigns","description":"Pauses up to 50 campaigns, one at a time in request order, each as `POST /v1/campaigns/{campaignId}/pause`\ndoes. `results` has one entry per id: `status` is `paused`, or the `error.code` of that\ncampaign's own pause (`not_found`, `invalid_state`) with that `error`. A campaign the call did not\nreach within 60 seconds is `not_run`, untouched: send its id again. A `400 validation_failed` on `ids` (missing, over 50, not positive or repeated) means nothing ran.\nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 480 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.bulk-pause","parameters":[{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignBulkRunRequest"}}}},"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/CampaignBulkRunResultResponse"}}}},"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":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":480,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/bulk-resume":{"post":{"tags":["campaigns"],"summary":"Resume several campaigns","description":"Resumes up to 50 campaigns, one at a time in request order, each as `POST /v1/campaigns/{campaignId}/resume`\ndoes, behind the same checks. `results` has one entry per id: `status` is `resumed`, or the\n`error.code` of that campaign's own resume with that `error`, its `details` and `refusal`\n(`validation_failed` with detail `no_sendable_inbox`, `free_plan_sending_needs_plan`,\n`approval_required`, `invalid_state`, `not_found`). A campaign the call did not reach within 60\nseconds is `not_run`, untouched: send its id again. A `400 validation_failed` on `ids`\n(missing, over 50, not positive or repeated) means nothing ran. Requires Campaigns edit and the `launch`\npermission.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.bulk-resume","parameters":[{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignBulkRunRequest"}}}},"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/CampaignBulkRunResultResponse"}}}},"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":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":240,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/inboxes":{"get":{"tags":["campaigns"],"summary":"List a campaign's inboxes","description":"Returns the inboxes the campaign sends from.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.list-inboxes","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxListResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"put":{"tags":["campaigns"],"summary":"Replace a campaign's inboxes","description":"Sets the inboxes the campaign sends from and returns them. The new set replaces the old one.\n            \nSend `inboxIds` for a saved list, or `assignAllActive` to save every inbox that can send through\nKenso, optionally only those of one `provider`. Send `allInboxes` `true` to use all inboxes\ninstead: every inbox a launch would assign joins now, and inboxes connected later join too. Paused inboxes the\ncampaign does not already have are left out. `allInboxes` ignores the other fields and needs the sender\nrouting feature.\n            \nErrors:\n            \n- `400 validation_failed`: `inboxIds` is missing, names an inbox that is not in this workspace or\n  cannot send, no inbox matched `assignAllActive` or `allInboxes`, or `provider` is unknown.\n  Detail code `feature_disabled` means the workspace does not have the sender routing feature.\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.replace-inboxes","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceCampaignInboxesRequest"}}}},"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/InboxListResponse"}}}},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/linkedin-accounts":{"get":{"tags":["campaigns"],"summary":"List a campaign's LinkedIn accounts","description":"Returns the LinkedIn accounts the campaign runs its LinkedIn steps from.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.list-linkedin-accounts","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedInAccountListResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"put":{"tags":["campaigns"],"summary":"Replace a campaign's LinkedIn accounts","description":"Sets the LinkedIn accounts the campaign uses and returns them. The new set replaces the old one. Send\n`linkedInAccountIds`, or `assignAllConnected` `true` to assign every connected LinkedIn account\nin the workspace.\n            \nErrors:\n            \n- `400 validation_failed`: `linkedInAccountIds` is missing or names an account that is not in this\n  workspace, or `assignAllConnected` found no connected account.\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.replace-linkedin-accounts","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceCampaignLinkedInAccountsRequest"}}}},"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/LinkedInAccountListResponse"}}}},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/linkedin-settings":{"get":{"tags":["campaigns"],"summary":"Get a campaign's LinkedIn settings","description":"Returns how the campaign uses LinkedIn alongside email: whether LinkedIn steps run, how the two channels combine,\nhow long to wait on connection requests, and which replies stop which channel.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.get-linkedin-settings","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedInSettingsResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"put":{"tags":["campaigns"],"summary":"Replace a campaign's LinkedIn settings","description":"Saves all of the campaign's LinkedIn settings at once and returns them. Send every field: an omitted boolean is\nsaved as false, and an omitted `conditionWaitDays` as 14. Only `stopSequenceForCompanyOnReply` keeps\nits current value when omitted.\n            \n`channelPolicy` is `linkedin_only`, `linkedin_first_email_fallback`,\n`email_first_linkedin_reinforce` or `parallel`. Set `linkedin_only` before launch: a launched\ncampaign cannot switch to it, because contacts already in its email sequence would keep getting emails.\n            \nErrors:\n            \n- `400 validation_failed`: `channelPolicy` is missing or unknown, `notAcceptedAfterDays` is not\n  1 to 90, `conditionWaitDays` is not 1 to 60, or a launched campaign would switch to\n  `linkedin_only`.\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.replace-linkedin-settings","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceLinkedInSettingsRequest"}}}},"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/LinkedInSettingsResponse"}}}},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/launch":{"post":{"tags":["campaigns"],"summary":"Launch a campaign","description":"Starts sending the campaign and returns it once the launch is confirmed. Calling it again while the campaign is\nlaunching or sending changes nothing. Check `GET /v1/campaigns/{campaignId}/launch-readiness` first to see\nwhat would stop the launch.\n            \nOn a Draft whose leads were never prepared, such as a duplicate, launch starts preparing them and turns\nauto-launch on, so the campaign launches on its own once its first leads are ready. The answer is the campaign\nwith `status` `building` and `autoLaunchWhenReady` true. An import that has not finished, a\nsequence with conditions that cannot launch, a billing hold, an invalid schedule, a LinkedIn setup that cannot\nsend, or no inbox that can send refuses it first, as below.\n            \nWhen your client must approve the copy, a contact list or other items first, the launch asks them and is refused\nuntil they approve.\n            \nErrors:\n            \n- `400 validation_failed`: the campaign is not ready to launch, for example its schedule is invalid, no\n  inbox can send, or its LinkedIn setup is incomplete. When no channel the campaign sends on can send,\n  `error.details` has one entry whose `code` names the channel: `no_sendable_inbox` (field\n  `inboxes`) when the campaign has no inbox that can send or every one is paused, and\n  `no_sendable_linkedin_account` (field `linkedInAccounts`) when no LinkedIn account it sends from is\n  connected or every one is paused. Branch on the code, not the message. A campaign with a sequence with\n  conditions that cannot send is refused the same way: `error.details` has one entry on the field\n  `campaignId` whose `code` is `open_tracking_off` when the sequence branches on an opened email:\n  opens are not tracked, so remove the opened conditions, then launch again.\n- `402 plan_limit_reached`: sending is suspended for non-payment. `402 dispute_hold`: sending is held\n  during a payment dispute.\n- `402 free_plan_sending_needs_plan`: the workspace is on the Free plan, which sends nothing for a workspace\n  created 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 call again.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 approval_required`: your client has to approve first; the `kinds` detail lists what waits, such\n  as `copy` or `lead_list`.\n- `409 acknowledgement_required`: the campaign has contacts in a country with consent-first cold email\n  rules, and nobody has acknowledged those rules for this campaign yet.\n- `409 conflict`: another launch in the workspace is in progress. Try again shortly.\n- `409 invalid_state`: the workspace's data is scheduled for deletion or being deleted.\n- `503 service_unavailable`: Kenso could not start sending right now. Try again shortly.\n            \nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 10 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.launch","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}},{"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"}}],"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/CampaignResponse"}}}},"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":["dispute_hold","free_plan_sending_needs_plan","plan_limit_reached"]},"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":["acknowledgement_required","approval_required","conflict","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":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":10,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/duplicate":{"post":{"tags":["campaigns"],"summary":"Duplicate a campaign","description":"Creates a draft copy of the campaign's setup in the same workspace and returns it, with its URL in the\n`Location` header. The copy is named `name`, or \"Copy of\" plus the original name.\n            \nWith `includeContacts` true, Kenso also copies the contacts and their AI and enrichment data in the\nbackground. An email keeps its verification result only when it was verified in the last 30 days; the others\ngo back to unknown. Send history is never copied.\n            \nErrors:\n            \n- `400 validation_failed`: the workspace is inactive, or the campaign is a recruiting campaign and the\n  workspace does not have the recruiting feature.\n- `402 plan_limit_reached`: `includeContacts` is true and the source campaign's contacts would pass\n  the campaign's import limit or, on Kenso Lifetime, the license's contacts (one pool across its workspaces).\n  For the license, `error.refusal` carries the code `LIFETIME_CONTACT_LIMIT_REACHED`. Kenso checks\n  this before it copies any contact, and keeps no copy of the campaign.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `429 rate_limited`: the workspace made too many copies in a short time, or too many copies with contacts\n  are still running. Try again later.\n            \nRequires Campaigns edit.\n\nRate limit: 20 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.duplicate","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign to copy.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateCampaignBody"}}}},"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/CampaignResponse"}}}},"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":["plan_limit_reached"]},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":20,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/pause":{"post":{"tags":["campaigns"],"summary":"Pause a campaign","description":"Pauses the campaign's sending, processing and AI workflows together, and returns the campaign. Parts that are not\nrunning are left as they are. Pausing a paused campaign changes nothing. If one part fails to pause, the call\nreturns that error and you can call it again.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 invalid_state`: the campaign is still launching. Try again once the launch finishes.\n            \nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.pause","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"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"]},"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"]},"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":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/resume":{"post":{"tags":["campaigns"],"summary":"Resume a campaign","description":"Resumes the campaign's sending, processing and AI workflows together, and returns the campaign. Parts that were\nnot paused are left as they are. Resuming a running campaign changes nothing. If one part fails to resume, the\ncall returns that error and you can call it again.\n            \nErrors:\n            \n- `400 validation_failed`: sending cannot resume, for example because no inbox can send.\n- `402 free_plan_sending_needs_plan`: the workspace is on the Free plan, which sends nothing for a workspace\n  created 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 call again.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 approval_required`: your client has to approve changes first; the `kinds` detail lists what\n  waits.\n- `409 invalid_state`: the campaign is still launching, or the workspace's data is scheduled for deletion\n  or being deleted.\n            \nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.resume","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"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"]},"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":["approval_required","invalid_state"]},"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":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":240,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/launch-readiness":{"get":{"tags":["campaigns"],"summary":"Check whether a campaign can launch","description":"Returns whether the campaign can launch, each condition that stands in the way, and an estimate of how long\nsending will take. Read it before `POST /v1/campaigns/{campaignId}/launch`.\n            \n`reasons` lists what blocks the launch, plus advisory notices that do not. `warnings` never change\n`canLaunch`. `approval_required` means your client was asked and the launch is refused until they\napprove; `approval_will_be_requested` means nobody was asked yet, and the launch will ask them and then wait.\nBoth list what waits in `kinds`. On a campaign that translates its steps, a\n`localization_incomplete` warning per language names the steps with no approved translation and whether\nthose contacts get the source text or are held. When the estimate cannot be calculated, its counts are omitted and\na `sending_estimate_unavailable` warning says why.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.get-launch-readiness","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchReadinessResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/workflow-readiness":{"get":{"tags":["campaigns"],"summary":"Check whether a campaign's workflows can start","description":"Runs the checks that must pass before the campaign's enrichment, email verification and AI workflows can start,\nand returns each one with `isPassed`. The checks cover imported contacts or an active signal, the contact\nlimit, the name, the schedule, the email sequence and its AI variables. Whether the campaign can start sending\nis `GET /v1/campaigns/{campaignId}/launch-readiness`.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.get-workflow-readiness","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowReadinessResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/mail-providers":{"get":{"tags":["campaigns"],"summary":"Count contacts by gateway and mailbox host","description":"Counts the campaign's contacts by the email security gateway in front of their address and by the host of their\nmailbox. Each contact is judged by its first Safe or Verified email, the one the contact list shows.\n            \n`gateways` lists every security gateway and `mailboxProviders` every mailbox host and forwarding\nservice Kenso tracks, including those with 0 contacts, most contacts first. `pendingCount` counts contacts\nwhose domain is not checked for a gateway yet. At most 100,000 contacts are counted; past that,\n`isPartial` is true.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `security_gateways` feature on your workspace. Until it is on, calls answer 404.","operationId":"campaigns.get-mail-providers","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMailProvidersResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["security_gateways"],"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/weekly-report":{"get":{"tags":["campaigns"],"summary":"Get a campaign's weekly report","description":"Returns one week of the campaign's email numbers, its numbers to date and per segment, what changed during the\nweek, and what happens next. The sentences in `changed` and `next` are written from the data, not by\nAI.\n            \n`weekOf` is any date in the Monday-to-Sunday week you want, as `YYYY-MM-DD` from 2000-01-01 to one\nyear from today. Without it, the report covers the latest week that has ended both in the report's time zone and\nin UTC. `timeZone` is an IANA name such as `Europe/Berlin`; without it the campaign's sending time\nzone is used, else UTC. The week's dates are picked in that time zone, and its numbers are counted on those days\nin UTC, as on the Analytics tab. `toDate` and `segments` run from the day the campaign was created (at\nmost 366 days back) to the end of the week. `next` describes now, in the campaign's sending time zone, and\nis empty for a week older than the default week.\n            \nErrors:\n            \n- `400 validation_failed`: `weekOf` is not a `YYYY-MM-DD` date in range, or `timeZone` is\n  not an IANA time zone name.\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.get-weekly-report","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"weekOf","in":"query","description":"Any date in the week to report, as `YYYY-MM-DD`. Defaults to the latest finished week.","schema":{"type":"string"}},{"name":"timeZone","in":"query","description":"IANA time zone the week's dates are picked in. Defaults to the campaign's sending time zone, else UTC.","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/CampaignWeeklyReportResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/scoring":{"get":{"tags":["campaigns"],"summary":"Get a campaign's lead scoring setting","description":"Returns whether lead scoring is on for the campaign.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.get-scoring","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoringSettingsResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"put":{"tags":["campaigns"],"summary":"Turn lead scoring on or off","description":"Turns lead scoring on or off for the campaign and returns the new setting. Score contacts with\n`POST /v1/campaigns/{campaignId}/scoring/run`.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.replace-scoring","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceScoringSettingsRequest"}}}},"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/ScoringSettingsResponse"}}}},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/ai-workflows":{"get":{"tags":["campaigns"],"summary":"List a campaign's AI workflows","description":"Returns the AI workflows attached to the campaign. Ids: 1 qualification, 2 personalization, 3 rewriting,\n4 segmentation, 6 scoring, 8 line check.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.list-ai-workflows","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignAiWorkflowListResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"put":{"tags":["campaigns"],"summary":"Replace a campaign's AI workflows","description":"Sets the AI workflows the campaign runs and returns them. Send every workflow id the campaign should run in\n`aiWorkflowIds`: ids you leave out are detached, and `[]` detaches all of them. To add one workflow,\nread the current set first. No other campaign field changes.\n            \nIds: 1 qualification, 2 personalization, 3 rewriting, 4 segmentation, 6 scoring, 8 line check. Rewriting runs\nonly when the campaign has rewriting prompts. Line check grades personalization lines before they are saved and\nholds a contact whose lines fail. A campaign gets it with personalization by default, and this call does not add\nit: keep 8 in the list to keep it on.\n            \nWhile the campaign is scheduled, launching or sending, 1, 2 and 4 must stay as they are and 3 can only be added,\nbecause they decide which contacts may send. Pause the campaign first to change them. 6 and 8 can change at any\ntime.\n            \nErrors:\n            \n- `400 validation_failed`: `aiWorkflowIds` is missing or holds an unknown id.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 invalid_state`: the change touches 1, 2, 3 or 4 in a way that is not allowed while the campaign is\n  scheduled, launching or sending.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.replace-ai-workflows","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceCampaignAiWorkflowsRequest"}}}},"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/CampaignAiWorkflowListResponse"}}}},"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"]},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/scoring/run":{"post":{"tags":["campaigns"],"summary":"Score a campaign's contacts","description":"Scores the campaign's qualified contacts and returns a finished `lead_scoring` job with the counts. The run\ncompletes within the request; read the job again with `GET /v1/jobs/{jobId}?type=lead_scoring`. Each score\nis the contact's `qualityScore`.\n            \nSend `contactIds` to score those contacts, or omit it to let Kenso pick. `limit` caps the run at 1 to\n1000 contacts, 100 by default. Lead scoring must be on for the campaign.\n            \nErrors:\n            \n- `400 validation_failed`: `limit` is not 1 to 1000.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 conflict`: lead scoring is off for the campaign, or none of the contacts are qualified, so nothing\n  was scored.\n            \nRequires Campaigns edit and the `ask` permission.\n\nRate limit: 60 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.run-scoring","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunCampaignScoringRequest"}}}},"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/JobResponse"}}}},"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":["conflict"]},"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":"campaigns","access":"edit","features":["ask"],"summary":"Campaigns edit and the `ask` permission"},"x-ken-rate-limit":{"limit":60,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/enrichment-runs":{"post":{"tags":["campaigns"],"summary":"Start an enrichment run","description":"Matches the campaign's contacts and their companies against Kenso's people and company data to fill in missing\ndetails. The call returns an `enrichment` job once every batch is queued; the matching runs in the\nbackground. `minConfidence` is the lowest match confidence to accept, from 0 to 1, 0.5 by default.\n            \nErrors:\n            \n- `400 validation_failed`: `minConfidence` is not between 0 and 1.\n- `400 validation_failed`: the workspace is a developer sandbox. A sandbox holds seeded and test data only,\n  so enrichment runs are not available in it.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `429 rate_limited`: the workspace started too many enrichment runs in a short time. Try again later.\n- `503 service_unavailable`: a batch could not be queued. Try again shortly.\n            \nRequires Campaigns edit.\n\nRate limit: 10 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.create-enrichment-run","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEnrichmentRunRequest"}}}},"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/JobResponse"}}}},"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"]},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":10,"windowSeconds":60,"per":"api_key","summary":"10 requests a minute per API key; 20 requests a minute and 500 a day per workspace (Free plan: 2 a minute and 50 a day)","quotas":[{"policy":"enrichmentCalls","per":"workspace","limits":[{"limit":20,"windowSeconds":60},{"limit":500,"windowSeconds":86400}],"plans":[{"plan":"Free","limits":[{"limit":2,"windowSeconds":60},{"limit":50,"windowSeconds":86400}]}]}]}}},"/v1/campaigns/{campaignId}/retry-enrichment":{"post":{"tags":["campaigns"],"summary":"Retry failed enrichment","description":"Clears the campaign's failed website reads and failed email searches so Kenso tries those contacts and\ncompanies again, and returns how many were cleared. It does not restart processing and does not change\nqualification, personalization or what was sent. If enrichment is paused, the failures are still cleared and\nthe retries wait until it resumes. Calling it when nothing failed returns zero counts.\n            \nErrors:\n            \n- `400 validation_failed`: the campaign is archived.\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns edit.\n\nRate limit: 10 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.retry-enrichment","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryEnrichmentResponse"}}}},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":10,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/launch-schedule":{"put":{"tags":["campaigns"],"summary":"Schedule a campaign's launch","description":"Sets when the campaign launches and returns it, with `launchAt` set and `autoLaunchWhenReady` on. At\nthat time Kenso launches it as you would, with the same checks (billing, credits, inboxes, client approval). If\nthe campaign is not `ready` yet by then, it launches as soon as it is. Where the client approves campaigns,\nKenso asks the client as soon as the campaign is `ready`, so the approval can be in by then; a launch still\nwaiting on it goes out once the client approves. Sends then follow its sending days,\nwindow and time zone, so a launch on a Sunday for a weekday campaign sends its first emails on Monday. Launching\nit yourself before then launches it now. Call it again to move the time, and\n`DELETE /v1/campaigns/{campaignId}/launch-schedule` to clear it.\n            \nIf the launch is refused at that time, for example because sending credits ran out, the campaign stays\n`ready` for you to launch by hand, and Kenso does not try again.\n            \nErrors:\n            \n- `400 validation_failed`: `launchAt` is missing, under 5 minutes or over 90 days from now, or the\n  campaign cannot be scheduled: a trigger campaign, an approval test campaign, or one that already launched.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 conflict`: auto-launch already ran for this campaign.\n            \nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `launch_schedule` feature on your workspace. Until it is on, calls answer 404.","operationId":"campaigns.set-launch-schedule","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetCampaignLaunchScheduleBody"}}}},"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/CampaignResponse"}}}},"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":["conflict"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["launch_schedule"],"x-ken-permission":{"kind":"page","page":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}},"delete":{"tags":["campaigns"],"summary":"Clear a campaign's launch schedule","description":"Removes the scheduled launch time and returns the campaign. With `autoLaunchWhenReady` false (the default)\nthe campaign waits for you to launch it; with true it launches as soon as it is `ready`, which can be right\naway. Clearing a campaign with no schedule, or one that already launched, changes nothing.\n            \nErrors:\n            \n- `400 validation_failed`: the schedule can no longer change, for example on a campaign that is launching.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 conflict`: the scheduled launch already ran.\n            \nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `launch_schedule` feature on your workspace. Until it is on, calls answer 404.","operationId":"campaigns.clear-launch-schedule","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"autoLaunchWhenReady","in":"query","description":"True keeps auto-launch on once the schedule is gone. Defaults to false.","schema":{"type":"boolean","default":false}},{"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/CampaignResponse"}}}},"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":["conflict"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["launch_schedule"],"x-ken-permission":{"kind":"page","page":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/restart":{"post":{"tags":["campaigns"],"summary":"Restart a campaign's processing","description":"Runs the campaign's processing again from the start. Use it to recover a campaign that stalled or failed, or to\nreprocess after you change its setup. Returns the campaign.\n            \nOn a draft campaign it starts processing behind the same readiness checks as resume. A campaign with\n`autoLaunchWhenReady` on launches by itself once processing reaches `ready`.\n            \nErrors:\n            \n- `400 validation_failed`: the campaign is archived, is a draft trigger campaign (start it with\n  `POST /v1/campaigns/{campaignId}/resume`), or fails the readiness checks.\n- `404 not_found`: the campaign does not exist in this workspace.\n- `409 invalid_state`: the workspace's data is scheduled for deletion or being deleted.\n            \nRequires Campaigns edit and the `launch` permission.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.restart","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"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"]},"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":"campaigns","access":"edit","features":["launch"],"summary":"Campaigns edit and the `launch` permission"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/sender-routing":{"get":{"tags":["campaigns"],"summary":"Get a campaign's sender routing","description":"Returns the campaign's sender routing rules with what each one covers now. Each rule sends the first email to\ncontacts on one mailbox provider or security gateway only from the rule's domains and inboxes. A security\ngateway rule wins over a mailbox provider rule. Contacts no rule matches get their first email from the inboxes\nno rule claims (`everyoneElse`).\n            \nFor each rule and for `everyoneElse` you get the campaign's inboxes that can send now, their combined daily\nlimit, and the contacts that can still get an email and match now. At most 100,000 contacts are read, and a\ncontact whose provider is still being detected is in no group. `warnings` lists rules with no inbox that\ncan send (`rule_no_inbox`), contacts left with no inbox (`everyone_else_no_inbox`), and rules that\nneed more than 5 days to reach their contacts (`rule_slow`). `allInboxes` shows whether the campaign\nuses all inboxes or a saved list.\n            \nErrors:\n            \n- `400 validation_failed`: the workspace does not have the sender routing feature (detail code\n  `feature_disabled`).\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.get-sender-routing","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SenderRoutingResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"put":{"tags":["campaigns"],"summary":"Replace a campaign's sender routing rules","description":"Replaces every sender routing rule of the campaign and returns the routing as\n`GET /v1/campaigns/{campaignId}/sender-routing` does. Send `[]` in `rules` to clear them.\n            \nEach rule names one mailbox provider or security gateway in `provider` (one rule per provider) and at least\none whole sending domain in `domains` or single inbox in `inboxIds`. Inboxes added later on a listed\ndomain join the rule. The rules apply to first emails planned from now on and to queued first emails when they\nsend. Follow-ups always come from the inbox that sent the first email.\n            \nErrors:\n            \n- `400 validation_failed`: a rule is invalid. Detail codes: `unknown_provider`,\n  `unsupported_provider`, `duplicate_provider`, `empty_rule` (no domain and no inbox),\n  `unknown_domain` (no workspace inbox on that domain), `unknown_inbox`, or `feature_disabled`\n  when the workspace does not have the sender routing feature.\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.replace-sender-routing","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceCampaignSenderRoutingRequest"}}}},"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/SenderRoutingResponse"}}}},"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":"campaigns","access":"edit","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/recipient-providers":{"get":{"tags":["campaigns"],"summary":"Count contacts by recipient provider","description":"Counts the campaign's contacts that can still get an email under every mailbox provider and security gateway\nKenso tracks, including those with 0 contacts, most contacts first. Use it to plan sender routing rules.\n            \nEach contact is placed by the domain of the address Kenso emails. A contact counts once under its mailbox\nprovider and once under its security gateway. `pendingCount` counts contacts whose provider is still being\ndetected, and `noProviderCount` those with no known provider. At most 100,000 contacts are counted; past\nthat, `isPartial` is true.\n            \nErrors:\n            \n- `400 validation_failed`: the workspace does not have the sender routing feature (detail code\n  `feature_disabled`).\n- `404 not_found`: the campaign does not exist in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"campaigns.list-recipient-providers","parameters":[{"name":"campaignId","in":"path","description":"Id of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientProviderCountsResponse"}}}},"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":"campaigns","access":"view","summary":"Campaigns 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."},"Campaign":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the campaign.","format":"int64"},"name":{"type":"string","description":"Display name of the campaign.","nullable":true},"status":{"type":"string","description":"Where the campaign stands: `draft`, `building`, `ready`, `active` (sending or launching),\n`paused`, `completed`, `error` or `archived`. A campaign that is both building and ready\nshows `ready`."},"channel":{"type":"string","description":"Always `email` for now."},"contactLimit":{"type":"integer","description":"The campaign's contact limit. With `contactLimitPeriod` `month` it is the new qualified contacts\nwith a Safe email the campaign may add per UTC calendar month; with `total` it is a lifetime total.","format":"int32"},"contactLimitPeriod":{"type":"string","description":"What `contactLimit` counts: `month` or `total`."},"contactLimitUsed":{"type":"integer","description":"Contacts counted against `contactLimit`: this month's for a monthly limit, else `contactCount`.","format":"int32"},"contactLimitResetsAt":{"type":"string","description":"When a monthly count starts again (UTC), the next 1st at 00:00. Omitted for a total limit.","format":"date-time","nullable":true},"fairUseContactLimit":{"type":"integer","description":"The lifetime fair-use ceiling that applies on top of a monthly limit. Omitted for a total limit.","format":"int32","nullable":true},"contactLimitReached":{"type":"boolean","description":"True while Kenso stops adding contacts because the campaign hit its contact limit, the fair-use ceiling or the\nworkspace ran out of lead credits."},"contactLimitReachedReason":{"type":"string","description":"Why `contactLimitReached` is true: `monthly_limit`, `contact_limit`, `fair_use` or\n`lead_credits`. Omitted when it is false.","nullable":true},"contactCount":{"type":"integer","description":"Contacts in the campaign with a valid email. `leadCount` counts every contact.","format":"int32"},"leadCount":{"type":"integer","description":"Every contact in the campaign, with or without an email, so a LinkedIn-only campaign shows its contacts.\nSingle-campaign responses count it live. On `GET /v1/campaigns` it comes from a cached count that usually\ntrails by under 15 minutes. Omitted when the count cannot be read or does not finish within 1 second on a very\nlarge workspace.","format":"int32","nullable":true},"readyLeadCount":{"type":"integer","description":"Ready leads still waiting for their first email: leads that pass the sequencer's ready checks (qualified when the\ncampaign qualifies, a Safe or Verified email, every variable the sequence uses filled, an active segment, not\nblocklisted), have no email sent or queued, and whose sequence has not stopped (for example after a reply, a hard\nbounce or an unsubscribe). `POST /v1/contacts/search` with `awaitingFirstEmail` lists the same leads.\nSingle-campaign responses count it live, waiting up to 2 seconds before they return the last stored count. On\n`GET /v1/campaigns` it is the stored count: a list recounts the counts of launched campaigns older than 10\nminutes in the background, so it can trail, and a campaign with no stored count yet omits it. Omitted when it\ncannot be read.","format":"int32","nullable":true},"linkedInOnly":{"type":"boolean","description":"True for a LinkedIn-only campaign: a batch campaign whose LinkedIn settings say LinkedIn only, with an active\nLinkedIn step and no usable email step. Returned only on `GET /v1/campaigns` items, and omitted when it\ncannot be read.","nullable":true},"segmentCount":{"type":"integer","description":"Number of segments in the campaign. Omitted when it was not read.","format":"int32","nullable":true},"inboxCount":{"type":"integer","description":"Number of inboxes the campaign sends from: the inboxes `GET /v1/campaigns/{campaignId}/inboxes` lists, 0\nwhen it has none. Omitted when it could not be read.","format":"int32","nullable":true},"tagIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of the tags on the campaign, ascending: the tags `GET /v1/tags` lists that are assigned to it, empty when\nit has none. Returned only on `GET /v1/campaigns` items, with `includeTagIds=true`.","nullable":true},"createdAt":{"type":"string","description":"When the campaign was created (UTC).","format":"date-time"},"launchedAt":{"type":"string","description":"When the campaign first launched (UTC). Omitted until it launches.","format":"date-time","nullable":true},"sourceStatus":{"type":"string","description":"Where contact sourcing for the campaign stands: `draft`, `to_scrape`, `in_progress`,\n`scraped`, `done` or `error`. `status` is the overall state."},"sendingStatus":{"type":"string","description":"Where sending stands: `not_started`, `scheduled`, `launching`, `sending`, `paused`,\n`completed`, `error` or `archived`. `status` is `active` while this is\n`sending` or `launching`."},"processingStatus":{"type":"array","items":{"type":"string"},"description":"The processing steps running or done, as a list: `draft`, `to_do`, `uploading`,\n`importing`, `scraping`, `qualifying`, `enriching_data`, `finding_emails`,\n`verifying_emails`, `segmenting`, `personalizing`, `rewriting`, `generating_links`,\n`ready`, `finished`, `done`, `paused` or `error`. `[\"none\"]` when nothing is set."},"sendingDays":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Days the campaign sends on, sorted: 0 (Sunday) to 6 (Saturday). Omitted when none are set.","nullable":true},"sendingStartTime":{"type":"string","description":"Start of the daily sending window, such as `09:00`, in `sendingTimezone`. Omitted when not set.","nullable":true},"sendingEndTime":{"type":"string","description":"End of the daily sending window, such as `17:00`, in `sendingTimezone`. Omitted when not set.","nullable":true},"sendingTimezone":{"type":"string","description":"Time zone of the sending window: a supported IANA name such as `America/New_York`, or `prospect` to\nsend in each contact's own time zone. Omitted when not set.","nullable":true},"maxEmailsPerDay":{"type":"integer","description":"Most emails the campaign sends per day across its inboxes. Omitted when not set.","format":"int32","nullable":true},"sendingError":{"type":"string","description":"The current sending problem, as text: the kind of failure, how many sends failed recently, and the inboxes\ninvolved. Set while hard send failures stay above the alert rate, and cleared once they drop. Omitted when there\nis none.","nullable":true},"sendingErrorAt":{"type":"string","description":"When the current `sendingError` began (UTC). Omitted with it.","format":"date-time","nullable":true},"ownerMemberId":{"type":"integer","description":"Member id of the campaign owner: the owner set on the campaign, else the member who created it while they are\nstill in the workspace. Omitted when neither applies.","format":"int64","nullable":true},"stopOnReply":{"type":"boolean","description":"A contact's reply stops their sequence. When false, neutral and positive replies let it continue, and a\nnegative reply, an unsubscribe or a booked meeting still stops it. This and the other sending switches\n(`trackClicks`, `unsubscribeLink`) take effect only when the workspace has the campaign send settings\nfeature; the field shows the saved value either way. `trackOpens` is always false."},"stopCompanyOnReply":{"type":"boolean","description":"A reply also stops every other contact at the same company. It is the same setting as\n`stopSequenceForCompanyOnReply` in the LinkedIn settings. New sales campaigns start with it on and a\nduplicate keeps its source's value. False when the campaign has no LinkedIn settings."},"groupSameCompanySends":{"type":"boolean","description":"Contacts at the same company get their emails on the same day. New sales campaigns start with it on."},"newLeadsFirst":{"type":"boolean","description":"First emails take the campaign's daily capacity ahead of follow-ups, so every contact gets email 1 before older\ncontacts get their next step. False (the default) sends due follow-ups first. On a campaign that keeps getting\nnew contacts, follow-ups can wait as long as it stays on, so turn it off once `awaitingFirstEmailCount`\nreaches 0. Duplicates, templates saved from the campaign and drafts made from those templates start with it off."},"catchAllLaneEnabled":{"type":"boolean","description":"The campaign opts in to the catch-all lane: Kenso may also send to unverified catch-all addresses whose\ncatch-all score is high enough, from the workspace's own inboxes, with a daily cap per campaign and per inbox.\nThe lane pauses itself when too many of its sends bounce (`catchAllLanePausedAt`). False (the default)\nnever sends to a catch-all address. It has no effect until Kenso turns the lane on for all workspaces, and\ncopies of the campaign start with it off."},"emailVerifiers":{"type":"array","items":{"type":"string"},"description":"The verifiers that check the campaign's emails: Kenso's (`kenso`, its own mailbox check, `leadmagic`,\nLeadMagic catch-all, and `findymail`) run first, in the order Kenso picks, then `zerobounce`, then\n`neverbounce`, which run on the workspace's own ZeroBounce or NeverBounce key and spend its credits, never\nKenso's. Each is asked only for the emails the ones before it left undecided. An empty list means the campaign\nverifies no email; a PATCH names at least one. Returned on single-campaign responses only.","nullable":true},"catchAllLanePausedAt":{"type":"string","description":"When the catch-all lane paused itself because too many of its sends hard-bounced (UTC). Kenso sets and clears\nit; you cannot write it. Omitted while the lane is not paused.","format":"date-time","nullable":true},"sourceLanguage":{"type":"string","description":"Language the steps are written in: a market locale such as `fr-FR`, or a bare language such as\n`en` (the default). Changing this or any other language setting needs the multilingual outreach feature."},"languageMode":{"type":"string","description":"How the campaign picks the language of each email: `source_only` (the default) sends every contact the\nsource text, and `auto` sends a contact the approved translation for their language when\n`enabledLanguages` lists it."},"enabledLanguages":{"type":"array","items":{"type":"string"},"description":"Market locales the campaign translates into, such as `fr-FR` and `es-MX`. Empty when none."},"formalityOverrides":{"type":"object","additionalProperties":{"type":"string"},"description":"Tone per locale, `formal` or `informal`, overriding the locale's default. Empty when every locale uses\nits default."},"languageFallback":{"type":"string","description":"What an `auto` campaign does for a contact whose language has no approved translation: `source` (the\ndefault) sends the source text, `hold` holds the contact until a translation is approved."},"awaitingFirstEmailCount":{"type":"integer","description":"Ready contacts still waiting for their first email. Not counted: contacts in a paused segment or held back by\nthe ready checks, company Cc members, contacts paused in bulk, and contacts whose sequence already stopped (for\nexample after a company reply, a hard bounce or an unsubscribe). Contacts waiting for batch approval, held by an\naccount play, or live in another campaign are counted, so the number can stop falling above 0 while they wait.\nReturned on single-campaign responses while `newLeadsFirst` is true; omitted otherwise, on the list, and\nwhen it cannot be read. It is the same count as `readyLeadCount`.","format":"int32","nullable":true},"rampUpDays":{"type":"integer","description":"Ramp-up length in scheduled sending days, from 0 (no ramp) to 30. Daily volume grows over these days. New\ncampaigns start at 5.","format":"int32"},"trackClicks":{"type":"boolean","description":"Links in emails go through tracking links. See `stopOnReply` for when this switch applies."},"trackOpens":{"type":"boolean","description":"Always false: campaign emails never carry an open-tracking pixel. Opens are not tracked and are never reported."},"unsubscribeLink":{"type":"boolean","description":"Emails carry the `List-Unsubscribe` headers. When false, the headers are left out only of steps whose body\nhas the `{{unsubscribe_link}}` link, so every email still has a way to opt out. See `stopOnReply` for\nwhen this switch applies."},"sendAsPlainText":{"type":"boolean","description":"Emails written as HTML go out as plain text only (`text/plain`, no HTML part). Off by default; Kenso can turn\nit off for every campaign at once, so a campaign with it on may still send HTML. Steps with a drawn handwritten\nletter, a video, a Studio email, a provider-built message or any image in the sent body (a signature logo counts)\nkeep their HTML. Unlike `stopOnReply` and the other sending switches, changing it needs no feature."},"protectAccountPlays":{"type":"boolean","description":"Skip people in active account plays (stage `warming`, `engaged`, `meeting_booked` or `in_deal`). New\ncampaigns start with it on. It applies only when the workspace has account plays."},"bookingMeetingTypeId":{"type":"integer","description":"Id of the round robin meeting type that takes this campaign's bookings when the contact's account owner and the\nsender cannot. Omitted when none is set.","format":"int64","nullable":true},"replyTo":{"type":"string","description":"This campaign's Reply-To address, used instead of the workspace's. It is a connected inbox of the workspace,\nand emails sent from that same inbox carry no Reply-To. Omitted when the campaign uses the workspace's setting.","nullable":true},"excludedCountries":{"type":"array","items":{"type":"string"},"description":"Countries this campaign never sends to, as upper-case ISO 3166-1 alpha-2 codes, sorted. Imports drop a contact\nfrom a listed country, and Kenso skips one already in the campaign. A contact whose country is unknown is kept.\nEmpty (the default) blocks no country."},"kind":{"type":"string","description":"Campaign type: `sales` or `recruiting`. Set when the campaign is created and cannot change."},"roleId":{"type":"integer","description":"Id of the main role a recruiting campaign hires for. Null when none is set; always returned.","format":"int64","nullable":true},"mode":{"type":"string","description":"How contacts enter the campaign: `batch` sends to a fixed set of contacts, and `trigger` adds contacts\nover time as signals come in. A batch campaign can become a trigger campaign, but not the other way round."},"autoLaunchWhenReady":{"type":"boolean","description":"The campaign launches itself, and starts spending sending credits, once it reaches `ready`. Changing it\nneeds the `launch` permission."},"launchAt":{"type":"string","description":"When the campaign is scheduled to launch (UTC). At that time Kenso launches it, or as soon as it reaches\n`ready` after that time; sends then follow the campaign's sending days, window and time zone. Set it with\n`PUT /v1/campaigns/{campaignId}/launch-schedule`. Omitted when no launch is scheduled, and once the campaign\nhas launched.","format":"date-time","nullable":true},"migration":{"allOf":[{"$ref":"#/components/schemas/CampaignMigrationOrigin"}],"description":"Where an imported campaign came from. Omitted for campaigns made in Kenso."},"approvalsWaiting":{"type":"integer","description":"First emails waiting for approval in the campaign's pending or rewriting batches. 0 when none.","format":"int32"},"forecast":{"allOf":[{"$ref":"#/components/schemas/CampaignForecast"}],"description":"Sending progress and the estimated finish. Returned while `sendingStatus` is `sending` or\n`paused` and a forecast under 24 hours old knows the remaining sends. Omitted for drafts, campaigns that\nhave not started sending, completed and archived campaigns, trigger campaigns (they never finish) and campaigns\nwith nothing planned."},"pausedReason":{"allOf":[{"$ref":"#/components/schemas/CampaignPausedReason"}],"description":"Why sending is paused. Returned only while `sendingStatus` is `paused`."},"warmStart":{"type":"boolean","description":"For the campaign's first days after launch (14 by default), its first emails go to its highest-scored contacts first\n(contacts without a lead score after them, in their usual order), at a low daily volume. Follow-ups keep their\norder. The window counts from launch, not from when this is turned on: turned on inside it, the lower volume starts\nthat day; turned on after it, nothing changes. Off by default; duplicates, templates saved from the campaign and\ndrafts made from those templates start with it off."}},"additionalProperties":false,"description":"A campaign: its contacts, sending schedule, sending switches and where it stands.","example":{"id":4821,"name":"Q4 SaaS founders","status":"active","channel":"email","contactLimit":2500,"contactLimitPeriod":"total","contactLimitUsed":1840,"contactLimitReached":false,"contactCount":1840,"leadCount":2115,"segmentCount":2,"inboxCount":6,"createdAt":"2026-09-23T15:02:11Z","launchedAt":"2026-09-29T13:00:00Z","sourceStatus":"done","sendingStatus":"sending","processingStatus":["finished"],"sendingDays":[1,2,3,4,5],"sendingStartTime":"09:00","sendingEndTime":"17:00","sendingTimezone":"America/New_York","maxEmailsPerDay":300,"ownerMemberId":1093,"stopOnReply":true,"stopCompanyOnReply":true,"groupSameCompanySends":true,"newLeadsFirst":false,"warmStart":false,"catchAllLaneEnabled":false,"sourceLanguage":"en","languageMode":"source_only","enabledLanguages":[],"formalityOverrides":{},"languageFallback":"source","rampUpDays":5,"trackClicks":false,"trackOpens":false,"unsubscribeLink":true,"sendAsPlainText":false,"protectAccountPlays":true,"excludedCountries":[],"kind":"sales","mode":"batch","autoLaunchWhenReady":false,"approvalsWaiting":0,"forecast":{"plannedSendCount":3680,"sentCount":2208,"remainingSendCount":1472,"progress":0.6,"estimatedFinishAt":"2026-10-20T20:40:00Z","effectiveDailyCapacity":300,"calculatedAt":"2026-10-14T09:35:00Z"}}},"CampaignAgentWork":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The campaign.","format":"int64"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/CampaignAgentWorkSetting"},"description":"One entry per kind a campaign can override; only `personalization` for now."}},"additionalProperties":false,"description":"Who runs a campaign's share of Kenso's AI work that can wait, where the campaign overrides its workspace.","example":{"campaignId":4821,"settings":[{"kind":"personalization","executor":"my_agent","workspaceExecutor":"kenso_ai","updatedAt":"2026-10-14T09:41:27Z"}]}},"CampaignAgentWorkResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/CampaignAgentWork"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"CampaignAgentWorkSetting":{"type":"object","properties":{"kind":{"type":"string","description":"`personalization`."},"executor":{"type":"string","description":"The campaign's override: `kenso_ai` or `my_agent`. Null when the campaign follows its workspace's\nsetting (workspaceExecutor).","nullable":true},"workspaceExecutor":{"type":"string","description":"The workspace's setting for the kind (`kenso_ai` or `my_agent`), which applies with no override."},"updatedAt":{"type":"string","description":"When the override was last saved, in UTC; null with no override.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"One kind of agent work for the campaign."},"CampaignAiWorkflow":{"type":"object","properties":{"id":{"type":"integer","description":"Workflow id: 1 qualification, 2 personalization, 3 rewriting, 4 segmentation, 6 scoring or 8 line check.","format":"int64"},"flow":{"type":"string","description":"Workflow name: `qualification`, `personalization`, `rewriting`, `segmentation`,\n`scoring` or `line_check`."}},"additionalProperties":false,"description":"An AI workflow attached to a campaign.","example":{"id":2,"flow":"personalization"}},"CampaignAiWorkflowListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/CampaignAiWorkflow"},"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."},"CampaignBulkRunItem":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The campaign's id.","format":"int64"},"status":{"type":"string","description":"`paused` or `resumed`, else the `error.code` of the campaign's own pause or resume, or `not_run`\nwhen the call reached its time limit before this campaign."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"The error the campaign's own pause or resume answers, with its details and refusal. Omitted on success."}},"additionalProperties":false,"description":"What a bulk pause or resume did with one campaign."},"CampaignBulkRunRequest":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer","format":"int64"},"description":"1 to 50 campaign ids, each once. They run one at a time in this order.","nullable":true}},"additionalProperties":false,"description":"The campaigns to pause or resume.","example":{"ids":[4821,4822]}},"CampaignBulkRunResult":{"type":"object","properties":{"succeeded":{"type":"integer","description":"Campaigns paused or resumed, including those that already were.","format":"int32"},"failed":{"type":"integer","description":"Campaigns that could not be paused or resumed.","format":"int32"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CampaignBulkRunItem"},"description":"One entry per id in `ids`, in request order."}},"additionalProperties":false,"description":"What a bulk pause or resume did, with one entry per campaign in request order.","example":{"succeeded":1,"failed":1,"results":[{"campaignId":4821,"status":"resumed"},{"campaignId":4822,"status":"validation_failed","error":{"code":"validation_failed","message":"No inbox in this campaign can send.","details":[{"field":"inboxes","code":"no_sendable_inbox","message":"No inbox in this campaign can send."}]}}]}},"CampaignBulkRunResultResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/CampaignBulkRunResult"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"CampaignForecast":{"type":"object","properties":{"plannedSendCount":{"type":"integer","description":"Emails planned for the whole campaign: `sentCount` plus `remainingSendCount`.","format":"int32"},"sentCount":{"type":"integer","description":"Emails sent so far. It comes from daily totals, so today's emails can appear the next day.","format":"int32"},"remainingSendCount":{"type":"integer","description":"Emails still planned, for the contacts in the campaign and the steps they have left.","format":"int32"},"progress":{"type":"number","description":"Share of planned emails sent: `sentCount` divided by `plannedSendCount`, from 0 to 1 with four\ndecimals. It measures emails sent, not the share of contacts reached.","format":"double"},"estimatedFinishAt":{"type":"string","description":"When the last planned email should go out (UTC). Returned only while the campaign is sending and every\nremaining email fits in the forecast. Omitted while paused, when no inbox has capacity for the campaign, when\nthe sending window cannot be used, or when the finish is more than two years away.","format":"date-time","nullable":true},"effectiveDailyCapacity":{"type":"integer","description":"Emails per day the campaign gets while sending; 0 when no inbox has capacity for it. Omitted while paused, when\nunknown, and for about 5 minutes after a resume until the next forecast.","format":"int32","nullable":true},"calculatedAt":{"type":"string","description":"When the forecast was calculated (UTC). Always under 24 hours old; an older forecast is not returned.","format":"date-time"}},"additionalProperties":false,"description":"How far a sending or paused campaign is through its planned emails, and when it should finish. Kenso refreshes\nthe forecast every 5 minutes from the inboxes' daily capacity (shared with the workspace's other campaigns),\n`maxEmailsPerDay`, the sending days, window and time zone, and the waits between steps."},"CampaignListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"},"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."},"CampaignMailProviders":{"type":"object","properties":{"gateways":{"type":"array","items":{"$ref":"#/components/schemas/MailProviderCount"},"description":"Every security gateway Kenso tracks, including those with 0 contacts, most contacts first."},"mailboxProviders":{"type":"array","items":{"$ref":"#/components/schemas/MailProviderCount"},"description":"Every mailbox host and forwarding service Kenso tracks, including those with 0 contacts, most contacts first."},"pendingCount":{"type":"integer","description":"Contacts whose email domain is not checked for a gateway yet.","format":"int32"},"isPartial":{"type":"boolean","description":"True when the campaign has more than 100,000 contacts, so only the first 100,000 are counted and the counts are a\nminimum."}},"additionalProperties":false,"description":"How a campaign's contacts split by email security gateway and by mailbox host.","example":{"gateways":[{"slug":"proofpoint","name":"Proofpoint","count":212},{"slug":"mimecast","name":"Mimecast","count":87}],"mailboxProviders":[{"slug":"google_workspace","name":"Google Workspace","count":1104},{"slug":"microsoft_365","name":"Microsoft 365","count":736}],"pendingCount":64,"isPartial":false}},"CampaignMailProvidersResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/CampaignMailProviders"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"CampaignMigrationOrigin":{"type":"object","properties":{"connectionId":{"type":"integer","description":"Id of the import connection the campaign came through.","format":"int64"},"vendor":{"type":"string","description":"The tool the campaign was imported from: `instantly`, `smartlead`, `emailbison`,\n`salesforge`, `lemlist`, `apollo`, `replyio`, `salesloft` or `outreach`."},"sourceAccountId":{"type":"string","description":"Id of the account in that tool."},"sourceCampaignId":{"type":"string","description":"Id of the campaign in that tool."},"sourceStatus":{"type":"string","description":"The campaign's status in that tool at the last sync, such as `active` or `paused`, or\n`unknown`."},"syncedAt":{"type":"string","description":"When Kenso last synced the campaign from that tool (UTC). Omitted before the first sync.","format":"date-time","nullable":true},"cutoverAt":{"type":"string","description":"When sending is set to move from that tool to Kenso (UTC). Omitted when no switch-over time was set.","format":"date-time","nullable":true},"historyFrom":{"type":"string","description":"First day of the imported daily stats (`YYYY-MM-DD`). Null, not omitted, when no stats were imported.","nullable":true},"historyTo":{"type":"string","description":"Last day of the imported daily stats (`YYYY-MM-DD`). Null when `historyFrom` is null.","nullable":true}},"additionalProperties":false,"description":"The tool, account and campaign an imported campaign came from."},"CampaignPausedReason":{"type":"object","properties":{"kind":{"type":"string","description":"What paused it: `user` (a member, or an agent acting for one), `bounce_guard` (too many hard\nbounces), `sending_error` (paused after repeated send failures; Kenso does not pause for send failures\ntoday, so a campaign whose sends keep failing stays sending and shows `sendingError` instead),\n`holiday` (the US holiday pause),\n`client_approval` (waiting for your client to approve changed copy or a contact list; approval resumes it,\nor leaves it paused for you to resume when it cannot send), `billing` (sending suspended for non-payment),\n`workspace_locked` (the workspace was deactivated or locked), `other` (another automatic pause) or\n`unknown` (no reason was recorded, as for pauses before Kenso recorded them). New values may be added."},"at":{"type":"string","description":"When sending stopped (UTC). Omitted when the time was not recorded.","format":"date-time","nullable":true},"byMemberId":{"type":"integer","description":"For `user` only: the member who paused the campaign, or for whom an agent paused it. Omitted when unknown.","format":"int64","nullable":true},"detail":{"type":"string","description":"What was recorded, for display: the evidence for `bounce_guard` and `sending_error`, who paused it\nfor `user` (for example \"Jordan Lee via Claude Code\"), or the system that paused it for `other`.\nOmitted for other kinds.","nullable":true}},"additionalProperties":false,"description":"Why a campaign's sending is paused, from what Kenso recorded when it stopped. A campaign is never paused for having\nno inboxes: a broken inbox leaves the campaign sending and shows on the inbox instead."},"CampaignResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Campaign"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"CampaignWeeklyReport":{"type":"object","properties":{"campaignId":{"type":"integer","description":"Id of the campaign.","format":"int64"},"campaignName":{"type":"string","description":"Name of the campaign."},"timeZone":{"type":"string","description":"IANA time zone the week's dates are picked in, such as `Europe/Berlin`, or `UTC`."},"week":{"allOf":[{"$ref":"#/components/schemas/CampaignWeeklyReportMetrics"}],"description":"The reported Monday-to-Sunday week. Its dates are picked in `timeZone`, and its numbers are counted on\nthose days in UTC, as on the Analytics tab."},"toDate":{"allOf":[{"$ref":"#/components/schemas/CampaignWeeklyReportMetrics"}],"description":"From the day the campaign was created (at most 366 days back) to the end of the week."},"segments":{"type":"array","items":{"$ref":"#/components/schemas/CampaignWeeklyReportSegment"},"description":"Numbers per segment, to date."},"changed":{"type":"array","items":{"$ref":"#/components/schemas/CampaignWeeklyReportChange"},"description":"What changed during the week, newest first, at most 6 items."},"next":{"type":"array","items":{"$ref":"#/components/schemas/CampaignWeeklyReportNextStep"},"description":"What happens next, as of the request. Empty for a week older than the default week."}},"additionalProperties":false,"description":"One campaign's weekly report. Its sentences are written from the data, not by AI.","example":{"campaignId":4821,"campaignName":"Q4 SaaS founders","timeZone":"America/New_York","week":{"startDate":"2026-10-05","endDate":"2026-10-11","sentCount":1420,"contactedCount":610,"replyCount":31,"interestedCount":9,"bounceCount":12},"toDate":{"startDate":"2026-09-23","endDate":"2026-10-11","sentCount":2208,"contactedCount":1104,"replyCount":52,"interestedCount":15,"bounceCount":21},"segments":[{"segmentId":1207,"name":"Engineering leaders","contactCount":640,"sentCount":1290,"replyRate":0.031}],"changed":[{"kind":"sequence_version_saved","occurredAt":"2026-10-08T14:20:00Z","segmentId":1207,"text":"Saved version 3 of the email sequence for Engineering leaders on Oct 8."}],"next":[{"kind":"campaign_remaining","remainingCount":660,"finishDate":"2026-10-20","text":"The last 660 leads start by Oct 20."}]}},"CampaignWeeklyReportChange":{"type":"object","properties":{"kind":{"type":"string","description":"What changed: `sequence_version_saved`, `linkedin_sequence_version_saved`, `variant_paused`,\n`variant_resumed`, `segment_added` or `leads_held_back`. `leads_held_back` is one line for\nthe week's contacts stopped for one-to-one account plays, dated by the last stop. New values may be added."},"occurredAt":{"type":"string","description":"When the change happened (UTC).","format":"date-time"},"segmentId":{"type":"integer","description":"Id of the segment the change belongs to. Omitted when it belongs to no segment.","format":"int64","nullable":true},"text":{"type":"string","description":"One plain-English sentence, dated by the change's day in UTC."}},"additionalProperties":false,"description":"One change made to the campaign during the week."},"CampaignWeeklyReportMetrics":{"type":"object","properties":{"startDate":{"type":"string","description":"First day of the range (`YYYY-MM-DD`)."},"endDate":{"type":"string","description":"Last day of the range, included (`YYYY-MM-DD`)."},"sentCount":{"type":"integer","description":"Emails sent.","format":"int32"},"contactedCount":{"type":"integer","description":"Distinct contacts emailed.","format":"int32"},"replyCount":{"type":"integer","description":"Distinct contacts who replied.","format":"int32"},"interestedCount":{"type":"integer","description":"Distinct contacts with a reply classified as interested.","format":"int32"},"bounceCount":{"type":"integer","description":"Emails that bounced.","format":"int32"}},"additionalProperties":false,"description":"Email numbers for a date range."},"CampaignWeeklyReportNextStep":{"type":"object","properties":{"kind":{"type":"string","description":"Line type: `campaign_remaining` (one line), followed by one `segment_remaining` line per segment\nwith contacts not started; or a single `campaign_paused`, `campaign_error`,\n`campaign_completed` or `campaign_archived` line. New values may be added."},"segmentId":{"type":"integer","description":"Id of the segment, on `segment_remaining` lines only.","format":"int64","nullable":true},"remainingCount":{"type":"integer","description":"Contacts not started yet: in the campaign on `campaign_remaining`, in the segment on\n`segment_remaining`. Omitted on other lines.","format":"int32","nullable":true},"finishDate":{"type":"string","description":"On `campaign_remaining`: the day the last contact should start at the last 7 days' pace\n(`YYYY-MM-DD`). Omitted when it cannot be estimated.","nullable":true},"text":{"type":"string","description":"One plain-English sentence."}},"additionalProperties":false,"description":"One line about what happens next."},"CampaignWeeklyReportResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/CampaignWeeklyReport"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"CampaignWeeklyReportSegment":{"type":"object","properties":{"segmentId":{"type":"integer","description":"Id of the segment.","format":"int64"},"name":{"type":"string","description":"Name of the segment."},"contactCount":{"type":"integer","description":"Contacts in the segment now.","format":"int32"},"sentCount":{"type":"integer","description":"Emails sent to date.","format":"int32"},"replyRate":{"type":"number","description":"Reply rate as a fraction from 0 to 1, the same as on the campaign performance segment rows.","format":"double"}},"additionalProperties":false,"description":"One segment's numbers, to date."},"ContactImportSkips":{"type":"object","properties":{"duplicateInCampaign":{"type":"integer","description":"Rows that match a contact already in this campaign.","format":"int32"},"duplicateInOtherCampaign":{"type":"integer","description":"Rows that match a contact in another campaign of the workspace, skipped because this campaign removes duplicates\nacross campaigns.","format":"int32"},"duplicateInSource":{"type":"integer","description":"Rows that repeat an earlier row of the same import.","format":"int32"},"alreadyContacted":{"type":"integer","description":"Rows that match a contact emailed within the campaign's recently emailed window.","format":"int32"},"blocklist":{"type":"integer","description":"Rows that match the workspace's blocklist.","format":"int32"},"failedValidation":{"type":"integer","description":"Rows that failed row checks, such as a row with no first and last name or no company name or domain.","format":"int32"},"salesNavigatorProfileUnresolved":{"type":"integer","description":"Sales Navigator people Kenso could not turn into a LinkedIn profile URL, so no LinkedIn step could reach them.","format":"int32"},"other":{"type":"integer","description":"Rows skipped for any other reason, such as a row Kenso could not process.","format":"int32"},"missingKey":{"type":"integer","description":"Rows with no email and no LinkedIn URL, dropped by the `missingKey` List check fix.","format":"int32"},"invalidEmail":{"type":"integer","description":"Rows whose email Kenso knows is invalid, dropped by the `invalidEmail` List check fix.","format":"int32"},"noMx":{"type":"integer","description":"Rows whose email domain takes no mail (no MX record), dropped by the `noMx` List check fix.","format":"int32"},"catchAll":{"type":"integer","description":"Rows whose email domain accepts every address, dropped by the `catchAll` List check fix.","format":"int32"},"personalEmail":{"type":"integer","description":"Rows with a personal email address, such as Gmail or Outlook.com, dropped by the `personalEmail` List check fix.","format":"int32"},"roleAddress":{"type":"integer","description":"Rows with a role address such as info@ or sales@, dropped by the `roleAddress` List check fix.","format":"int32"},"companyContacted":{"type":"integer","description":"Rows at a company where someone else recently got a Kenso email, dropped by the `companyContacted` List check fix.","format":"int32"},"companyCap":{"type":"integer","description":"Rows past the first 5 people at one company, dropped by the `companyCap` List check fix.","format":"int32"}},"additionalProperties":false,"description":"Rows a campaign contact import skipped, with each row counted under one reason."},"CreateCampaignRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Display name of the campaign. Required."},"contactLimit":{"type":"integer","description":"Most contacts the campaign may hold, greater than 0. Omit to set it later; workflows and launch need one.","format":"int32","nullable":true},"kind":{"type":"string","description":"Campaign type: `sales` (the default) or `recruiting`. A recruiting campaign needs the recruiting\nfeature.","nullable":true},"roleId":{"type":"integer","description":"Id of the main role a recruiting campaign hires for, a role in this workspace. Only for a recruiting campaign.","format":"int64","nullable":true},"source":{"type":"string","description":"Where in the app the campaign was started, for Kenso's product analytics: `builder` (the default) or\n`search`. It does not change the campaign. A call with an API key or from an agent is counted as such,\nwhatever it sends.","nullable":true}},"additionalProperties":false,"description":"A new campaign.","example":{"name":"Q4 SaaS founders","contactLimit":2500,"kind":"sales"}},"CreateEnrichmentRunRequest":{"type":"object","properties":{"minConfidence":{"type":"number","description":"Lowest match confidence to accept, from 0 to 1. Defaults to 0.5.","format":"float","nullable":true}},"additionalProperties":false,"description":"Options for an enrichment run.","example":{"minConfidence":0.7}},"DuplicateCampaignBody":{"type":"object","properties":{"name":{"type":"string","description":"Name of the copy. Omitted or blank names it \"Copy of\" plus the original name.","nullable":true},"includeContacts":{"type":"boolean","description":"True also copies the contacts and their AI and enrichment data, in the background. False (the default) copies\nonly the setup."}},"additionalProperties":false,"description":"Options for a campaign copy.","example":{"name":"Q1 SaaS founders","includeContacts":false}},"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`."},"Inbox":{"type":"object","properties":{"id":{"type":"integer","description":"The inbox id.","format":"int64"},"email":{"type":"string","description":"The inbox's email address."},"firstName":{"type":"string","description":"The sender's first name. Omitted when not set.","nullable":true},"lastName":{"type":"string","description":"The sender's last name. Omitted when not set.","nullable":true},"displayName":{"type":"string","description":"The sender name recipients see. Omitted when not set.","nullable":true},"signature":{"type":"string","description":"The HTML signature Kenso adds to email from this inbox. Omitted when not set.","nullable":true},"status":{"type":"string","description":"The inbox's state: `active`, `warmup`, `disconnected`, `paused`, `banned`,\n`connection_error`, `deleted`, `inactive` (its domain is about to expire), `replaced` (a\nrename gave the mailbox a new address, and this inbox keeps only its history) or `pending_provisioning`\n(Kenso is still setting up the mailbox). Only an `active` inbox sends campaign email. A pause shows in\n`pausedAt`, not here."},"role":{"type":"string","description":"What the inbox is for: `sending` (a campaign inbox), `replies` (the workspace's shared replies\ninbox, the address campaign replies go to) or `retired` (a campaign inbox Kenso switched to receive\nonly). A `replies` or `retired` inbox never joins a campaign or warmup, and Kenso keeps reading its\nmail."},"captureUntil":{"type":"string","description":"When a `retired` inbox's reply capture window ends, in UTC. Nothing changes automatically then: Kenso\nkeeps reading the inbox until it is deleted. Omitted unless the inbox is retired.","format":"date-time","nullable":true},"renewalEndsWindowEarly":{"type":"boolean","description":"For a `retired` inbox: true when its domain's registration expires before `captureUntil` and auto-renew\nis off. The domain can then lapse, and a new owner would get the replies. False when auto-renew is on, the\nregistration runs past `captureUntil`, or `captureUntil` has passed. Omitted when the inbox is not\nretired, or when Kenso does not know its domain or the registration's expiry.","nullable":true},"provider":{"type":"string","description":"The mailbox platform: `google`, `microsoft`, `azure` or `custom_smtp`.","nullable":true},"domainId":{"type":"integer","description":"The id of the inbox's domain in Kenso. Omitted when the domain is not one Kenso manages.","format":"int64","nullable":true},"dailySendLimit":{"type":"integer","description":"The most emails the inbox sends per day. Omitted when not set.","format":"int32","nullable":true},"forwarding":{"type":"string","description":"Where the inbox's incoming mail is forwarded: `ken_hosted` (to a Kenso address) or `client` (to\n`forwardingDestination`, an address of yours). Omitted when the inbox does not forward.","nullable":true},"forwardingDestination":{"type":"string","description":"The email address that receives the inbox's forwarded mail. Omitted when there is none.","nullable":true},"profileImageUrl":{"type":"string","description":"The URL of the inbox's sender photo: the photo Kenso set, else the photo the mailbox provider reports. Omitted\nwhen there is none.","nullable":true},"profilePhotoSupport":{"type":"string","description":"Whether Kenso can set this inbox's sender photo: `google` (a Google mailbox Kenso set up for you),\n`microsoft` (a Microsoft or Azure mailbox Kenso set up for you), `google_account` or\n`microsoft_account` (a member's own mailbox, whose photo only its owner can change) or `none`.\nSetting a photo also needs the workspace's `inbox_photos` feature.","nullable":true},"profilePhotoStatus":{"type":"string","description":"Whether the photo Kenso set reached the mailbox: `pending` (queued for a Microsoft or Azure mailbox and\nnot applied yet), `applied` or `failed` (no photo shows, and `profilePhotoError` says why).\nOmitted when Kenso set no photo, or set it before Kenso tracked this.","nullable":true},"profilePhotoStatusAt":{"type":"string","description":"When `profilePhotoStatus` last changed, in UTC. For `pending`, when the photo was queued.","format":"date-time","nullable":true},"profilePhotoError":{"type":"string","description":"Why the photo failed. Present only when `profilePhotoStatus` is `failed`.","nullable":true},"tagIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of the workspace's tags on this inbox. Empty when it has none."},"createdAt":{"type":"string","description":"When the inbox was added to Kenso, in UTC.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"When Kenso last synced the inbox's details, in UTC.","format":"date-time","nullable":true},"pausedAt":{"type":"string","description":"When a member paused outreach from this inbox, in UTC. Omitted when it is not paused. A paused inbox holds\ncampaign steps, triggers and approved one-to-one Accounts email, while warmup and reply sync keep running.\nSeparate from `status`.","format":"date-time","nullable":true},"isKenSendable":{"type":"boolean","description":"Whether Kenso can send campaign email from this inbox now. Present only on lists of the inboxes a campaign uses\nor can use.","nullable":true},"sendState":{"type":"string","description":"Whether the inbox can send now, and if not, the first reason why: `ready` (it sends), `gone`\n(deleted, replaced, turned off or banned, so it never sends again), `receive_only` (a `replies` or\n`retired` inbox), `needs_reconnect` (its sign-in failed or its connection is gone: reconnect it),\n`paused` (a member paused it, or its provider did), `warming` (warmup is not finished),\n`blocked_until` (a send block is in force until `sendBlock.until`) or `not_sendable` (Kenso\ncannot send from it for another reason, such as setup that is not finished or a daily limit of 0). For a shared\ncampaign inbox, `ready` means it is in the pool Kenso sends campaign email from, the same pool the launch\ncheck counts. For a member's own inbox, it means its owner can send from it. The warmup age gate and today's\ncap are separate (`warmup.daysLeft`, `health`). A paused inbox still sends the replies a member\nwrites. Omitted on the responses that create an inbox (read it again), and when Kenso could not work it out.","nullable":true},"oneToOneReadiness":{"allOf":[{"$ref":"#/components/schemas/InboxOneToOneReadiness"}],"description":"Whether an approved one-to-one email that names this inbox goes out now (an account's Sends from, or the From\nof a workflow's send step), and if not, why and what fixes it. The same answer as\n`GET /v1/inboxes/{inboxId}/one-to-one-readiness`. Separate from `sendState`, which is about campaign\nemail. Omitted on lists of the inboxes a campaign uses or can use, on the responses that create an inbox (read\nit again), and when Kenso could not work it out."},"sendingProvider":{"type":"string","description":"The slug of the provider account this inbox sends through, when the workspace connected that account itself.\nNull on every other inbox. An SMTP inbox Kenso runs reads `provider: custom_smtp` and no\n`sendingProvider`; Kenso staff get the slug on every provider inbox.","nullable":true},"isIngestReady":{"type":"boolean","description":"Whether Kenso can read replies from this inbox. An inbox can send before Kenso can read its replies. Present\nonly on lists of the inboxes a campaign uses or can use.","nullable":true},"ownerMemberId":{"type":"integer","description":"The member whose own mailbox this is. Omitted for a shared campaign inbox. A member's own mailbox never joins\na campaign or warmup.","format":"int64","nullable":true},"isPrimary":{"type":"boolean","description":"True when a member owns the inbox and its address is on one of the workspace's domains: its email domain or a\ndomain listed under Settings > Company. Kenso works it out on each read, so it follows later changes to that\nlist. Only a primary inbox sends the member's one-to-one Accounts email."},"isAccountsDefault":{"type":"boolean","description":"True on the one inbox per member that their accounts' one-to-one email goes out from when nothing names another:\ntheir lowest-id primary inbox that is connected and can send. An account's Sends from inbox, or the From of a\nworkflow's send step, picks another; left on Automatic, a workflow's email goes out from the account's Sends from\ninbox, else from this inbox of the account's owner. False on every other inbox, including a primary inbox that is\ndisconnected or not the member's first one."},"connectionApp":{"type":"string","description":"The Kenso app a Google or Microsoft connection was granted to: `ken_mail` (campaign mailboxes) or\n`ken_workspace` (a member's own mailbox). Omitted for SMTP and unconnected inboxes.","nullable":true},"trackOpens":{"type":"boolean","description":"The owner's open tracking option, off by default. Open tracking is unavailable: Kenso adds no open-tracking pixel\nto replies or to one-to-one Accounts email, and turning it on is refused (`open_tracking_unavailable`).\nPresent only on a member's own mailbox.","nullable":true},"usedBy":{"allOf":[{"$ref":"#/components/schemas/UsedBy"}],"description":"The live campaigns that send through this inbox, and whether Accounts uses it. Omitted when Kenso could not\nread it."},"warmup":{"allOf":[{"$ref":"#/components/schemas/InboxWarmupSummary"}],"description":"Warmup progress toward the minimum warmup age Kenso requires before cold sends. Omitted when no warmup sends\nwere reported for the inbox, unless an outreach bypass from Kenso covers it. The full warmup state is\n`GET /v1/inboxes/{inboxId}/warmup`."},"sendBlock":{"allOf":[{"$ref":"#/components/schemas/InboxSendBlock"}],"description":"The block that stops campaign sends from the inbox now. Omitted when the inbox is not blocked."},"healthScore":{"type":"integer","description":"Kenso's health score for the inbox, from 0 to 100, from the latest mailbox health check. Omitted when no check\nhas reported on the inbox.","format":"int32","nullable":true},"lastSentAt":{"type":"string","description":"The inbox's last send its mail server accepted, in UTC. Warmup sends do not count. Omitted when it sent\nnothing in the last 30 days, or when Kenso could not read it.","format":"date-time","nullable":true},"connection":{"allOf":[{"$ref":"#/components/schemas/InboxConnection"}],"description":"The health of Kenso's own connection to the mailbox. Omitted when Kenso has no connection of its own to the\nmailbox."},"health":{"allOf":[{"$ref":"#/components/schemas/InboxHealth"}],"description":"Today's sends against the inbox's daily cap, its ramp, its warmup readiness and what holds it back now. Only\non `GET /v1/inboxes/{inboxId}`, never on a list, and only when the workspace has the `agent_send`\nfeature. Omitted otherwise, and when Kenso could not read it."}},"additionalProperties":false,"description":"An inbox: a mailbox the workspace sends from and reads replies from. Which fields a response carries depends on\nthe call. Lists of the inboxes a campaign uses or can use carry fewer fields.","example":{"id":5530,"email":"alex@mail.example.com","firstName":"Alex","lastName":"Rivera","displayName":"Alex Rivera","signature":"Alex Rivera\nNorthwind Outbound","status":"active","role":"sending","provider":"google","domainId":640,"dailySendLimit":30,"profilePhotoSupport":"google","tagIds":[],"createdAt":"2026-08-31T10:15:00Z","updatedAt":"2026-10-14T09:41:27Z","isPrimary":false,"isAccountsDefault":false,"usedBy":{"campaigns":[{"id":4821,"name":"Q4 SaaS founders","status":"active"}],"accounts":false},"warmup":{"daysLeft":0},"healthScore":94,"lastSentAt":"2026-10-14T09:12:40Z"}},"InboxConnection":{"type":"object","properties":{"status":{"type":"string","description":"Connection state: `connected`, `disconnected`, `auth_expired` (the mailbox must be signed in\nagain) or `error`."},"checkedAt":{"type":"string","description":"When Kenso last checked the connection with the mail provider (UTC). Omitted before the first check.","format":"date-time","nullable":true},"error":{"type":"string","description":"Short reason from the mail provider, at most 300 characters, when `status` is `auth_expired` or\n`error`. It never contains credentials. Omitted otherwise.","nullable":true}},"additionalProperties":false,"description":"The health of Kenso's own connection to a mailbox, which it uses to send and to read replies."},"InboxHealth":{"type":"object","properties":{"sentToday":{"type":"integer","description":"Emails the mail provider accepted from this inbox so far in its send day, from campaigns and one-to-one replies.","format":"int32"},"reservedToday":{"type":"integer","description":"Emails being sent right now, which already count against today's limit.","format":"int32"},"limit":{"type":"integer","description":"Today's limit: the inbox's daily limit after its ramp-up, its domain's ramp-up and the mail provider's maximum.","format":"int32"},"remaining":{"type":"integer","description":"Emails the inbox can still send today: `limit` minus `sentToday` and `reservedToday`, never below 0.","format":"int32"},"dayEndsAt":{"type":"string","description":"When the send day ends (UTC). The day follows the time zone of the inbox's campaigns, or New York when none\nsets one.","format":"date-time"},"rampDay":{"type":"integer","description":"Day of the ramp-up: 1 during the first 24 hours of sending, and still returned once the ramp-up is over. Omitted\nwhen the limit could not be worked out from send history.","format":"int32","nullable":true},"rampComplete":{"type":"boolean","description":"True when the ramp-up reached its target and no longer lowers the limit. False when `rampDay` is omitted."},"warmupReadiness":{"type":"string","description":"Whether warmup cleared the inbox to send, with the same values as `readiness.outcome` on\n`GET /v1/inboxes/{inboxId}/warmup`: `ready`, `too_young`, `unconfirmed`, `bypassed`,\n`provider_stale` or `unavailable` (no recent warmup data, or no result for the inbox)."},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/InboxHealthBlock"},"description":"What holds the inbox back now. Empty when nothing does."},"bounceRate7d":{"type":"number","description":"Hard bounces divided by accepted emails over the last 7 days, from 0 to 1. Omitted when nothing was accepted in\nthat window, and when `rampDay` is omitted.","format":"double","nullable":true},"notes":{"type":"array","items":{"$ref":"#/components/schemas/InboxHealthNote"},"description":"What the inbox's state shows that holds no send now. Empty when there is nothing to show. Not a block: the\ninbox keeps sending."}},"additionalProperties":false,"description":"An inbox's sending health today: what it sent, what it may still send, and what holds it back."},"InboxHealthBlock":{"type":"object","properties":{"kind":{"type":"string","description":"What holds it back: `paused` (a member paused the inbox), `send_blocked` (Kenso blocked it, for\nexample after a failed placement test) or `sending_paused` (a pause on the inbox, its domain or the\nworkspace, that holds sends now: an operator's pause, which stops campaign sends and new agent threads, or any\npause once capacity limits are enforced)."},"reason":{"type":"string","description":"Why, as recorded: usually a code such as `mailbox_hard_bounce_rate`. Omitted when no reason was recorded.","nullable":true},"until":{"type":"string","description":"When the block ends (UTC). Omitted for `paused`, which lasts until a member resumes the inbox.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"One thing that holds an inbox back from sending."},"InboxHealthNote":{"type":"object","properties":{"kind":{"type":"string","description":"`sending_pause_observed`: an automatic pause (any pause Kenso opened itself, for example after a placement\ntest, bounces, complaints or a domain breach, and not an operator's) covers the inbox, its domain or the\nworkspace, but while capacity limits are not enforced it holds no send, so the inbox keeps sending."},"reason":{"type":"string","description":"Why, as recorded: usually a code such as `domain_bounce`. Omitted when no reason was recorded.","nullable":true},"until":{"type":"string","description":"When the pause ends (UTC).","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Something an inbox's state shows that holds no send."},"InboxImportJob":{"type":"object","properties":{"connectedCount":{"type":"integer","description":"Rows that connected an inbox.","format":"int32"},"failedCount":{"type":"integer","description":"Rows that failed to connect.","format":"int32"},"skippedCount":{"type":"integer","description":"Rows Kenso skipped, such as an inbox the workspace already has.","format":"int32"},"startedAt":{"type":"string","description":"When the import started on its first row, in UTC. Omitted while it waits in the queue.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"When the import last made progress, in UTC. An import with no progress for 10 minutes reads `failed`\nwith `error.code` `interrupted`.","format":"date-time"},"completedAt":{"type":"string","description":"When the import finished, in UTC. Omitted until it finishes.","format":"date-time","nullable":true},"rows":{"type":"array","items":{"$ref":"#/components/schemas/InboxImportRow"},"description":"Processed rows in `index` order, empty until the first row has a result. Returned when you create or get\nthe import, and omitted in lists and for a member without Delivery view.","nullable":true}},"additionalProperties":false,"description":"Counts and row results of an inbox import, without any passwords."},"InboxImportRow":{"type":"object","properties":{"index":{"type":"integer","description":"Zero-based position of the row in the request's `rows` array.","format":"int32"},"email":{"type":"string","description":"The row's email address."},"status":{"type":"string","description":"The row's result: `connected`, `failed` or `skipped`."},"inboxId":{"type":"integer","description":"The connected inbox, the existing inbox a skipped row matched, or the disconnected inbox a failed\nconnect left in the workspace. Omitted when there is none.","format":"int64","nullable":true},"errorCode":{"type":"string","description":"Why the row did not connect, omitted for a connected row. A skipped row has `already_exists`,\n`duplicate_in_file`, or `feature_disabled` or `forbidden` when the import stopped before the row\nbecause inbox import was turned off for the workspace or the member who started it lost Delivery edit. A failed\nrow has `email_in_use` (another Kenso inbox has the email), `host_failure_limit` (not tried, because\nits host refused several logins or could not be reached earlier in the import) or an API error code such as\n`validation_failed` or `service_unavailable`.","nullable":true},"message":{"type":"string","description":"A readable message about the row's result, when Kenso has one.","nullable":true},"firstName":{"type":"string","description":"On a connected row that set one in the file, the sender first name now on the mailbox. Omitted otherwise.","nullable":true},"lastName":{"type":"string","description":"On a connected row that set one in the file, the sender last name now on the mailbox. Omitted otherwise.","nullable":true},"dailySendLimit":{"type":"integer","description":"On a connected row that set one in the file, the daily limit now stored on the mailbox, after the provider\nceiling. Omitted otherwise.","format":"int32","nullable":true},"warnings":{"type":"array","items":{"type":"string"},"description":"Warning codes of a row that connected, omitted when there are none: `daily_limit_clamped` (the row's\n`dailySendLimit` was above the mailbox's provider ceiling and was stored at the ceiling) or\n`settings_not_applied` (the mailbox connected, but its names or limit could not be saved).","nullable":true},"details":{"type":"array","items":{"$ref":"#/components/schemas/InboxImportRowDetail"},"description":"On a row that failed a column check, one entry per refused column, with `field` naming the column. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One processed row of an inbox import."},"InboxImportRowDetail":{"type":"object","properties":{"field":{"type":"string","description":"The row column, such as `firstName` or `dailySendLimit`."},"code":{"type":"string","description":"Stable code for the problem, such as `invalid`."},"message":{"type":"string","description":"A sentence for people that says what is wrong with the column."}},"additionalProperties":false,"description":"One refused column of an inbox import row."},"InboxListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/Inbox"},"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."},"InboxOneToOneReadiness":{"type":"object","properties":{"inboxId":{"type":"integer","description":"The inbox.","format":"int64"},"email":{"type":"string","description":"Its address."},"senderKind":{"type":"string","description":"How it sends a 1:1 email: `member_mailbox` (a member's own mailbox, only as their primary inbox),\n`shared_inbox` (a shared campaign inbox on a cold sending domain) or `sending_identity` (a sending\nprovider identity, through its provider connection)."},"canSend":{"type":"boolean","description":"True when an approved 1:1 email touch that names this inbox (an Accounts touch, or a workflow\n`send.email` step's `fromInbox`) goes out now, and its reply comes back to Kenso. False when the touch\nwould wait (`connect_inbox`, or `inbox_paused` for `paused`)."},"reason":{"type":"string","description":"Why it cannot send; omitted when canSend is true. `receive_only`: retired or the replies\ninbox. `not_connected`: its connection, or a sending identity's provider connection, cannot send now.\n`replies_not_read`: a sending identity whose replies would not reach Kenso. `not_cold_sender`: not on\none of the workspace's cold sending domains. `not_primary`: a member's mailbox off the workspace's domains.\n`paused`: a member paused it. Tolerate values not listed here.","nullable":true},"message":{"type":"string","description":"What fixes it, for a person; omitted when canSend is true.","nullable":true},"signatureWarning":{"type":"string","description":"`brand_domain` when the inbox is a member's mailbox whose saved signature loads from or links to a\nKenso domain the mailbox's own domain does not cover in a way the brand check refuses (an image, a Kenso tracking or\nsystem link), so a 1:1 email from it goes out without the signature (the email itself still goes). A plain link to a\nKenso site is allowed and is no warning. Omitted when the signature goes out as saved, or the inbox adds none.\nTolerate values not listed here.","nullable":true},"signatureMessage":{"type":"string","description":"What fixes the signature, for a person, naming what the check found; omitted with signatureWarning.","nullable":true}},"additionalProperties":false,"description":"Whether an inbox can send a 1:1 email now, and if not why."},"InboxSendBlock":{"type":"object","properties":{"reason":{"type":"string","description":"Why Kenso blocked the inbox, as a code such as `mailbox_hard_bounce_rate`. Omitted when a person set the\nblock, or a rename did.","nullable":true},"until":{"type":"string","description":"When the block ends, in UTC. The inbox sends no campaign email until then.","format":"date-time"}},"additionalProperties":false,"description":"A block that stops campaign sends from an inbox until a set time."},"InboxWarmupSummary":{"type":"object","properties":{"daysLeft":{"type":"integer","description":"Days until the inbox reaches the minimum warmup age, counted from its first reported warmup send. 0 once it\ngets there, or when Kenso waived the age for the inbox. An outreach bypass from Kenso reports 0 even before any\nwarmup send.","format":"int32","nullable":true}},"additionalProperties":false,"description":"An inbox's progress toward the minimum warmup age Kenso requires before cold sends."},"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."},"Job":{"type":"object","properties":{"id":{"type":"integer","description":"The job's id. Ids are unique only within one `type`, so send `type` with the id when you read or\ncancel the job.","format":"int64"},"type":{"type":"string","description":"The job type: `contact_import`, `contact_export`, `domain_health`, `lead_scoring`,\n`enrichment`, `crawl`, `extraction`, `batch_scrape`, `knowledge_export`,\n`inbox_import` or `migration`."},"status":{"type":"string","description":"One of `queued`, `running`, `succeeded`, `failed` or `canceled`. Only `crawl`,\n`extraction`, `batch_scrape` and `migration` jobs reach `canceled`, and a `contact_export`\nor `knowledge_export` is `succeeded` from the start."},"progress":{"allOf":[{"$ref":"#/components/schemas/JobProgress"}],"description":"How far the job has run."},"pollAfterSeconds":{"type":"integer","description":"While the job is `queued` or `running`, how many seconds to wait before reading it again: 10 for a\n`crawl`, `extraction` or `batch_scrape` (each read asks the scraping provider), 30 for a\n`migration`, and 5 for the other types. Omitted once the job has finished.","format":"int32","nullable":true},"resource":{"allOf":[{"$ref":"#/components/schemas/JobResource"}],"description":"The object the job belongs to, such as its campaign. Omitted when it has none."},"createdAt":{"type":"string","description":"When the job was created, in UTC.","format":"date-time"},"downloadUrl":{"type":"string","description":"The path that downloads the job's file, such as `/v1/contact-exports/{exportId}/content`. Only on a\n`contact_export` or `knowledge_export`, and omitted for other types.","nullable":true},"error":{"allOf":[{"$ref":"#/components/schemas/JobError"}],"description":"Why the job failed. Present only when `status` is `failed`."},"result":{"description":"The raw status and output of a `crawl`, `extraction` or `batch_scrape`, such as the scraped pages.\nReturned only by `GET /v1/jobs/{jobId}` for those types, and omitted for other types and in lists."},"domainsListed":{"type":"integer","description":"For a finished `domain_health` job: how many of the checked domains are on a blocklist. Omitted for other\ntypes and until the job finishes.","format":"int32","nullable":true},"excludedLibraryContacts":{"type":"integer","description":"For a `contact_export` of kind `contacts`, `campaign` or `advanced`: how many contacts from a\nKenso library list the export left out, since Kenso never exports them. Omitted for other kinds and types, or when\nKenso could not count them.","format":"int32","nullable":true},"inboxImport":{"allOf":[{"$ref":"#/components/schemas/InboxImportJob"}],"description":"Counts and row results of an `inbox_import`. Omitted for other types."},"personImport":{"allOf":[{"$ref":"#/components/schemas/PersonImportJob"}],"description":"Counts of a `contact_import` with target `people`. Omitted for an import into a campaign and for other\ntypes."},"skipped":{"allOf":[{"$ref":"#/components/schemas/ContactImportSkips"}],"description":"Rows a `contact_import` into a campaign skipped, by reason, with 0 for a reason that skipped none. Omitted\nfor an import with target `people` and for other types."}},"additionalProperties":false,"description":"A background job, such as a contact import, a contact export or a crawl."},"JobError":{"type":"object","properties":{"code":{"type":"string","description":"The reason code. It is `failed` for every job type except `inbox_import`, which uses\n`interrupted`, `feature_disabled` or `forbidden`."},"message":{"type":"string","description":"A readable description of what went wrong."}},"additionalProperties":false,"description":"Why a job failed."},"JobProgress":{"type":"object","properties":{"completed":{"type":"integer","description":"How many items the job has finished. The item depends on `type`: for example imported contacts for a\ncampaign `contact_import`, checked domains for `domain_health` and processed rows for `inbox_import`.","format":"int32"},"total":{"type":"integer","description":"How many items the job handles in all. Omitted when Kenso does not know the total, as for `domain_health`.","format":"int32","nullable":true}},"additionalProperties":false,"description":"How far a job has run."},"JobResource":{"type":"object","properties":{"type":{"type":"string","description":"The kind of object: `campaign` for a campaign `contact_import`, a `contact_export` of a campaign,\n`lead_scoring` and `enrichment`, or `migration_run` for a `migration`."},"id":{"type":"integer","description":"The object's id.","format":"int64"}},"additionalProperties":false,"description":"The object a job belongs to."},"JobResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Job"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"LaunchForecast":{"type":"object","properties":{"status":{"type":"string","description":"Forecast state: `forecasted`, `ongoing`, `paused`, `not_started`, `completed` or\n`unavailable`."},"progress":{"type":"number","description":"Share of the planned emails already sent, from 0 to 1. Omitted when unknown.","format":"double","nullable":true},"estimatedFinishAt":{"type":"string","description":"When the last planned email should go out (UTC). Omitted when it cannot be estimated.","format":"date-time","nullable":true},"confidence":{"type":"string","description":"How reliable the forecast is: `none`, `low`, `medium` or `high`."},"reasonCodes":{"type":"array","items":{"type":"string"},"description":"What limits the forecast, such as `zero_eligible_capacity`, `snapshot_expired`,\n`simulation_horizon_exceeded` or `invalid_sending_window`. Empty when nothing does."},"statusExplanation":{"type":"string","description":"Why there is no forecast, ready to show to a person. Returned only when `status` is `unavailable`.","nullable":true},"remainingEmailCount":{"type":"integer","description":"Emails still to send. Omitted when unknown.","format":"int32","nullable":true},"effectiveDailyCapacity":{"type":"integer","description":"Emails per day the campaign gets from its inboxes' shared capacity. Omitted when unknown.","format":"int32","nullable":true},"scheduledNext3DayCount":{"type":"integer","description":"Emails already queued or planned for the next 3 UTC days. Kenso plans about 36 hours ahead, so this usually\ncovers about one sending day. Use `projectedNext3DayCount` for three-day volume.","format":"int32"},"effectiveScheduledNext3DayCount":{"type":"integer","description":"Equal to `scheduledNext3DayCount` while the campaign is sending, and 0 while it is paused (the queued emails\nstay in `scheduledNext3DayCount`). Add this field, not the queued one, when you total capacity across\ncampaigns.","format":"int32"},"projectedNext3DayCount":{"type":"integer","description":"Expected emails over the next 3 days: what is queued for today plus the daily capacity of the next two sending\ndays, capped by the emails left to send.","format":"int32"},"effectiveProjectedNext3DayCount":{"type":"integer","description":"Equal to `projectedNext3DayCount` while the campaign is sending, else 0.","format":"int32"},"readyContactCount":{"type":"integer","description":"Contacts ready to send to. Omitted when unknown.","format":"int32","nullable":true},"assignedTodayCount":{"type":"integer","description":"Emails queued for today's send day, in the campaign's time zone. Omitted when unknown.","format":"int32","nullable":true},"acceptedTodayCount":{"type":"integer","description":"Emails accepted for sending today, in the campaign's time zone. Omitted when unknown.","format":"int32","nullable":true},"calculatedAt":{"type":"string","description":"When the forecast was calculated (UTC).","format":"date-time"},"isStale":{"type":"boolean","description":"True when the forecast is more than 15 minutes old."}},"additionalProperties":false,"description":"Kenso's sending forecast for a campaign, refreshed every few minutes."},"LaunchReadiness":{"type":"object","properties":{"canLaunch":{"type":"boolean","description":"True when nothing in `reasons` blocks the launch. Some reasons are advisory and leave it true."},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/LaunchReadinessReason"},"description":"Conditions that stop the launch, plus advisory notices. Empty when there is nothing to report."},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/LaunchReadinessReason"},"description":"Conditions that do not stop the launch but change how the campaign sends. They never change\n`canLaunch`."},"contactLimit":{"type":"integer","description":"The campaign's contact limit used for the estimate. This and the other estimate counts are omitted when the\nestimate cannot be calculated; the `sending_estimate_unavailable` warning then says why.","format":"int32","nullable":true},"contactLimitPeriod":{"type":"string","description":"What `contactLimit` and the counts below cover: `month` for one month, else `total`. Omitted with\nthe estimate.","nullable":true},"emailStepCount":{"type":"integer","description":"Number of email steps in the sequence. Omitted with the estimate.","format":"int32","nullable":true},"totalEmailCount":{"type":"integer","description":"Emails the campaign sends in total: the contact limit times the email steps before it sends, or the emails sent\nplus those left once it sends. Omitted with the estimate.","format":"int32","nullable":true},"dailySendingLimit":{"type":"integer","description":"Emails per day the campaign's inboxes can send for it. Omitted with the estimate.","format":"int32","nullable":true},"estimatedDayCount":{"type":"integer","description":"Days until every email is sent at that daily rate. Omitted with the estimate.","format":"int32","nullable":true},"forecast":{"allOf":[{"$ref":"#/components/schemas/LaunchForecast"}],"description":"Kenso's live sending forecast for the campaign. Omitted when there is none."}},"additionalProperties":false,"description":"Whether a campaign can launch, what stands in the way, and how long sending should take.","example":{"canLaunch":true,"reasons":[],"warnings":[{"code":"sender_domain_without_click_host","message":"1 sending domain(s) on this campaign have no ready click-tracking host of their own: outreach.example.net (Kenso is still setting up link.outreach.example.net).","fixUrl":"delivery?tab=analytics"}],"contactLimit":2500,"contactLimitPeriod":"total","emailStepCount":3,"totalEmailCount":7500,"dailySendingLimit":300,"estimatedDayCount":25}},"LaunchReadinessReason":{"type":"object","properties":{"code":{"type":"string","description":"Stable code for the condition, such as `invalid_schedule`, `missing_prompt_coverage`,\n`approval_required` or `sending_suspended`. New codes may be added. The deliverability warnings are\n`sender_domain_without_click_host`, `html_step_on_google_track`, `smtp_inbox_daily_limit_above_10`\nand `smtp_domain_over_20_inboxes`; `GET /v1/deliverability-rules` names the rule behind each."},"message":{"type":"string","description":"Explanation of the condition, ready to show to a person."},"fixUrl":{"type":"string","description":"Relative app link to the page where the condition can be fixed. Omitted when there is none.","nullable":true},"kinds":{"type":"array","items":{"type":"string"},"description":"For `approval_required` and `approval_will_be_requested` only: what the launch waits on your client\nto approve, such as `copy`, `lead_list`, `settings`, `icp`, `report` or\n`account_plan`. Omitted for other codes.","nullable":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"For `free_plan_sending_needs_plan`, `workspace_read_only` and `card_required` only: the refusal\nlaunch answers `402` with (code `FREE_PLAN_SENDING_NEEDS_PLAN` or `WORKSPACE_READ_ONLY` with remedy\n`Upgrade`, or `CARD_REQUIRED` with remedy `UpdatePaymentMethod`). Omitted for other codes."}},"additionalProperties":false,"description":"One condition that blocks the launch, an advisory notice, or a warning."},"LaunchReadinessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/LaunchReadiness"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"LinkedInAccount":{"type":"object","properties":{"id":{"type":"integer","description":"The LinkedIn account id.","format":"int64"},"displayName":{"type":"string","description":"The account's name as Kenso shows it. Omitted when not set.","nullable":true},"publicIdentifier":{"type":"string","description":"The profile's public id, the last part of its LinkedIn URL. Omitted when not known.","nullable":true},"profileUrl":{"type":"string","description":"The LinkedIn profile URL. Omitted when not known.","nullable":true},"profileImageUrl":{"type":"string","description":"The URL of the profile photo. Omitted when there is none.","nullable":true},"headline":{"type":"string","description":"The profile headline. Omitted when there is none.","nullable":true},"status":{"type":"string","description":"The connection state: `connecting` (the connect session has not finished), `connected`,\n`credentials_error` (sign in again through a reconnect), `restricted` (LinkedIn restricted the\nprofile), `disconnected`, `deleted` or `connect_failed`. A pause shows in `pausedAt`, not\nhere."},"timezone":{"type":"string","description":"The account's IANA time zone, such as `Europe/London`. Omitted when not set, which means UTC.","nullable":true},"workingHours":{"type":"string","description":"The stored working hours, as a JSON string. Omitted when not set. `workingHoursSchedule` gives the same\nhours as an object, with the defaults filled in.","nullable":true},"dailyInviteCap":{"type":"integer","description":"The most connection invites the account sends per day.","format":"int32"},"dailyMessageCap":{"type":"integer","description":"The most messages and InMails the account sends per day.","format":"int32"},"dailyVisitCap":{"type":"integer","description":"The most profile visits the account makes per day.","format":"int32"},"createdAt":{"type":"string","description":"When the account was added to Kenso, in UTC.","format":"date-time"},"createdDatetime":{"type":"string","description":"The same value as `createdAt`. Use `createdAt`.","format":"date-time"},"updatedAt":{"type":"string","description":"When Kenso last synced the account's profile, in UTC. Omitted when it never has.","format":"date-time","nullable":true},"unipileAccountId":{"type":"string","description":"The id Kenso's LinkedIn connection uses for the account. Kenso support may ask for it. Omitted until the account\nconnects.","nullable":true},"statusChangedAt":{"type":"string","description":"When `status` last changed, in UTC. Omitted when it never has.","format":"date-time","nullable":true},"invitesToday":{"type":"integer","description":"Invites sent today, since the start of the account's day or over the last 24 hours, depending on how Kenso\ncounts the account's limits. Compare with `dailyInviteCap`. Omitted when Kenso could not read the counts.","format":"int32","nullable":true},"messagesToday":{"type":"integer","description":"Messages and InMails sent today, counted the same way as `invitesToday`.","format":"int32","nullable":true},"visitsToday":{"type":"integer","description":"Profile visits made today, counted the same way as `invitesToday`.","format":"int32","nullable":true},"invitesSent30d":{"type":"integer","description":"Invites sent in the last 30 days. Omitted when Kenso could not read it.","format":"int32","nullable":true},"acceptRate":{"type":"number","description":"The share of `invitesSent30d` that were accepted, from 0 to 1. Omitted when no invite was sent in that\ntime.","format":"double","nullable":true},"usedBy":{"allOf":[{"$ref":"#/components/schemas/UsedBy"}],"description":"The live campaigns that use this account, and whether Accounts uses it for one-to-one outreach. Omitted when\nKenso could not read it."},"lastActionAt":{"type":"string","description":"When the account last finished an outreach action, in UTC: the newest confirmed campaign step or Accounts\ntouch. A person's replies from the Inbox do not count. Omitted when there is none, or Kenso could not read it.","format":"date-time","nullable":true},"lastActionType":{"type":"string","description":"The action at `lastActionAt`: `visit`, `invite`, `message`, `inmail`,\n`voice_message`, `withdraw`, `follow`, `reaction`, `comment` or `endorse`.\nOmitted when `lastActionAt` is.","nullable":true},"pausedAt":{"type":"string","description":"When a member paused the account, in UTC. Omitted when it is not paused. A paused account sends no outreach\n(invites, messages, InMails, profile visits, withdrawals and approved Accounts notes), and neither do Ken's\nautonomous replies. They wait and go out after a resume. A person's replies from the Inbox and inbox sync keep\nrunning. Separate from `status`.","format":"date-time","nullable":true},"connectedByMemberId":{"type":"integer","description":"The member who connected the account. Outreach from it that needs approval waits for this member. Omitted for\nan account connected before Kenso recorded this.","format":"int64","nullable":true},"importConnections":{"type":"boolean","description":"True when Kenso imports the account's LinkedIn connections into Accounts as people and companies. Only the\nmember who connected the account or a workspace admin can change it."},"handoffsMutedAt":{"type":"string","description":"When the account's owner muted warm path handoffs on it, in UTC. Omitted when not muted. While any account an owner\nconnected is muted, no teammate's warm path hands that owner a hop.","format":"date-time","nullable":true},"researchReadsEnabledAt":{"type":"string","description":"When the account's owner turned on research reads, in UTC. Omitted when off. While it is set, Kenso may read public\nLinkedIn posts on the account a few times a day, inside its working hours.","format":"date-time","nullable":true},"importConnectionsChangedAt":{"type":"string","description":"When `importConnections` last changed, in UTC. Omitted when it never has.","format":"date-time","nullable":true},"networkOnly":{"type":"boolean","description":"True when the account only lends its owner's LinkedIn network to the workspace. Kenso syncs its connections and\nchats, but never adds it to a campaign, never picks it as an account's sending account and never sends from it\non its own. Set when the account connects; a workspace admin can change it."},"removedFromCampaignIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Only on the update that made the account network-only: the ids of the campaigns it sent for and was taken out\nof, ascending. Omitted otherwise.","nullable":true},"workingHoursSchedule":{"allOf":[{"$ref":"#/components/schemas/LinkedInWeeklySchedule"}],"description":"The account's working hours for each day of the week as Kenso applies them, in the account's\n`timezone`. Days not set use the defaults: Monday to Friday open 08:00 to 18:00, Saturday and Sunday\nclosed. A closed day still shows 08:00 to 18:00."},"products":{"allOf":[{"$ref":"#/components/schemas/LinkedInAccountProducts"}],"description":"The paid LinkedIn products on the account, as LinkedIn last reported them. Omitted until Kenso first checks."},"invitesLast7Days":{"type":"integer","description":"Invites sent in the last 7 days. Compare with `weeklyInviteCap`. This field and the other safety fields\n(`weeklyInviteCap`, `pendingInvites`, `pendingInviteCap`, `health`, `rampStage`,\n`rampInviteCap` and `safetyEnabled`) are omitted together when Kenso could not read them.","format":"int32","nullable":true},"weeklyInviteCap":{"type":"integer","description":"The most invites the account sends in any 7 days, at most 100.","format":"int32","nullable":true},"pendingInvites":{"type":"integer","description":"Invites still waiting for an answer, as the higher of Kenso's count and LinkedIn's.","format":"int32","nullable":true},"pendingInviteCap":{"type":"integer","description":"The account sends no new invites while `pendingInvites` is at or above this number.","format":"int32","nullable":true},"health":{"allOf":[{"$ref":"#/components/schemas/LinkedInAccountHealth"}],"description":"How well the account's invites are being accepted, over invites sent 3 to 30 days ago."},"rampStage":{"type":"integer","description":"The account's ramp stage: 0, 1 and 2 in its first three weeks, while Kenso raises a new account's invite\nvolume week by week, then 3 at full volume. It stops moving while `rampPlansEnabled` is true.","format":"int32","nullable":true},"rampInviteCap":{"type":"integer","description":"Today's invite cap from the ramp: 5, 10, then 20, then the account's `dailyInviteCap`. While\n`rampPlansEnabled` is true, today's cap of the invite row of `ramp`.","format":"int32","nullable":true},"safetyEnabled":{"type":"boolean","description":"False while Kenso shows the safety values but does not apply the weekly, pending and low acceptance caps yet.","nullable":true},"rampPlansEnabled":{"type":"boolean","description":"True once Kenso runs LinkedIn on the per-action ramp: the account's daily caps come from `ramp`. False\nwhile the caps still follow `rampStage` and `rampInviteCap`. Omitted when Kenso could not read it.","nullable":true},"rampStartedAt":{"type":"string","description":"When the ramp's week 0 started, UTC. Only while `rampPlansEnabled` is true.","format":"date-time","nullable":true},"ramp":{"type":"array","items":{"$ref":"#/components/schemas/LinkedInRampAction"},"description":"One row per action (invite, message, visit, follow, reaction, comment, endorse, accept): today's cap, the plan's\nstart, weekly step and ceiling, the week index and the date today's cap reaches the ceiling. Only while\n`rampPlansEnabled` is true. Edit it with `ramp` in `PATCH /v1/linkedin-accounts/{linkedinAccountId}`\nand restart it with `POST /v1/linkedin-accounts/{linkedinAccountId}/ramp/reset`.","nullable":true},"tagIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of the workspace's tags on the account, in ascending order. Empty when it has none. Set them with\n`POST /v1/tags/{tagId}/assignments` and `entityType` `linkedin_account`. Only\n`GET /v1/linkedin-accounts`, `GET /v1/linkedin-accounts/{linkedinAccountId}` and\n`PATCH /v1/linkedin-accounts/{linkedinAccountId}` carry it, and they omit it when Kenso could not read the\ntags. Other lists of LinkedIn accounts, such as a campaign's, never carry it.","nullable":true},"safetyHolds":{"type":"array","items":{"$ref":"#/components/schemas/LinkedInAccountSafetyHold"},"description":"The safety holds Kenso has on the account right now, at most one per `scope`, ordered `all_writes`,\n`invites`, `invite_notes`. Empty when it has none, or when Kenso could not read them. Only\n`GET /v1/linkedin-accounts`, `GET /v1/linkedin-accounts/{linkedinAccountId}`,\n`PATCH /v1/linkedin-accounts/{linkedinAccountId}` and its ramp reset carry it. Other lists of LinkedIn\naccounts, such as a campaign's, never carry it.","nullable":true}},"additionalProperties":false,"description":"A LinkedIn account connected to the workspace, with its limits, today's usage and the safety caps Kenso applies.\nWhich fields a response carries depends on the call.","example":{"id":2207,"displayName":"Alex Rivera","publicIdentifier":"alex-rivera-northwind","profileUrl":"https://www.linkedin.com/in/alex-rivera-northwind","headline":"Partnerships at Northwind Outbound","status":"connected","timezone":"America/New_York","dailyInviteCap":20,"dailyMessageCap":40,"dailyVisitCap":60,"createdAt":"2026-09-23T15:02:11Z","createdDatetime":"2026-09-23T15:02:11Z","invitesToday":8,"messagesToday":14,"visitsToday":21,"invitesSent30d":312,"acceptRate":0.34,"lastActionAt":"2026-10-14T09:12:48Z","lastActionType":"invite","connectedByMemberId":1093,"importConnections":true,"networkOnly":false,"tagIds":[]}},"LinkedInAccountHealth":{"type":"object","properties":{"status":{"type":"string","description":"Either `healthy` or `low_acceptance`. An account becomes `low_acceptance` when under 20% of at\nleast 40 invites were accepted, and goes back to `healthy` at 25%. While it is `low_acceptance`, it\nsends at most 5 invites a day."},"acceptRate":{"type":"number","description":"The share of the `sample` invites that were accepted, from 0 to 1. Omitted when `sample` is 0.","format":"double","nullable":true},"sample":{"type":"integer","description":"How many invites were sent 3 to 30 days ago.","format":"int32"},"changedAt":{"type":"string","description":"When `status` last changed, in UTC. Omitted when it never has.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"How well a LinkedIn account's connection invites are being accepted."},"LinkedInAccountListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/LinkedInAccount"},"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."},"LinkedInAccountProducts":{"type":"object","properties":{"premium":{"type":"boolean","description":"True when the account has LinkedIn Premium."},"salesNavigator":{"type":"boolean","description":"True when the account has Sales Navigator."},"recruiter":{"type":"boolean","description":"True when the account has LinkedIn Recruiter."},"checkedAt":{"type":"string","description":"When Kenso last checked the products, in UTC.","format":"date-time"}},"additionalProperties":false,"description":"The paid LinkedIn products on a LinkedIn account."},"LinkedInAccountSafetyHold":{"type":"object","properties":{"scope":{"allOf":[{"$ref":"#/components/schemas/LinkedInAccountSafetyHoldScope"}],"description":"The writes the hold stops: `all_writes` (every invite, message, InMail, profile visit and other outreach\naction), `invites` (new connection invites) or `invite_notes` (the note on an invite; the invite still\ngoes out without it)."},"until":{"type":"string","description":"When the hold ends, in UTC.","format":"date-time"},"reason":{"type":"string","description":"Why Kenso placed the hold, in words a member can read."},"source":{"type":"string","description":"The check that placed the hold, as a short code such as `account_warning`, `invite_streak`,\n`provider_streak`, `note_quota` or `reconnect_quiet`. New codes may be added."}},"additionalProperties":false,"description":"A safety hold Kenso placed on a LinkedIn account: until `until`, the account sends none of the writes\n`scope` names. Kenso places and lifts holds on its own; a member cannot."},"LinkedInAccountSafetyHoldScope":{"enum":["all_writes","invites","invite_notes"],"type":"string","description":"Which writes a LinkedIn account's safety hold stops."},"LinkedInRampAction":{"type":"object","properties":{"action":{"type":"string","description":"invite, message, visit, follow, reaction, comment, endorse or accept."},"todayCap":{"type":"integer","description":"Today's cap: `min(ceiling, start + stepPerWeek * weekIndex)`, then the action's hard ceiling.","format":"int32"},"start":{"type":"integer","description":"The cap in week 0.","format":"int32"},"stepPerWeek":{"type":"integer","description":"How much the cap rises each full week.","format":"int32"},"ceiling":{"type":"integer","description":"The cap the ramp stops at, at most the action's hard ceiling.","format":"int32"},"weekIndex":{"type":"integer","description":"Full weeks since `rampStartedAt`, in the account's time zone.","format":"int32"},"fullVolumeOn":{"type":"string","description":"The date the action reaches its ceiling (YYYY-MM-DD), in the account's time zone. `9999-12-31` when it\nnever does (no weekly step and a start below the ceiling).","format":"date"}},"additionalProperties":false,"description":"One action's row of a LinkedIn account's ramp."},"LinkedInSettings":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"True when the campaign runs LinkedIn steps."},"channelPolicy":{"type":"string","description":"How LinkedIn and email combine: `linkedin_only` sends no email, `linkedin_first_email_fallback`\nemails a contact only once LinkedIn cannot reach them, `email_first_linkedin_reinforce` starts LinkedIn\nafter the contact's email sequence has started, and `parallel` runs both independently."},"notAcceptedAfterDays":{"type":"integer","description":"Days to wait for a connection request to be accepted, from 1 to 90.","format":"int32"},"conditionWaitDays":{"type":"integer","description":"Days a step waits for its condition before it is skipped, from 1 to 60.","format":"int32"},"isWithdrawEnabled":{"type":"boolean","description":"True withdraws a connection request that was not accepted within `notAcceptedAfterDays`."},"stopLinkedInOnEmailReply":{"type":"boolean","description":"True stops a contact's LinkedIn steps when they reply by email."},"stopEmailOnLinkedInReply":{"type":"boolean","description":"True stops a contact's emails when they reply on LinkedIn."},"stopSequenceForCompanyOnReply":{"type":"boolean","description":"True stops the sequence for every contact at the same company when one of them replies. It is the same setting\nas the campaign's `stopCompanyOnReply`."},"stopAllChannelsOnReply":{"type":"boolean","description":"True stops every channel when the contact replies on any channel, also after their LinkedIn steps finished: a\nLinkedIn reply then still stops the emails (with `stopEmailOnLinkedInReply`). New campaigns start with true."}},"additionalProperties":false,"description":"How a campaign uses LinkedIn alongside email.","example":{"isEnabled":true,"channelPolicy":"email_first_linkedin_reinforce","notAcceptedAfterDays":21,"conditionWaitDays":14,"isWithdrawEnabled":true,"stopLinkedInOnEmailReply":true,"stopEmailOnLinkedInReply":true,"stopSequenceForCompanyOnReply":true,"stopAllChannelsOnReply":true}},"LinkedInSettingsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/LinkedInSettings"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"LinkedInWeeklySchedule":{"type":"object","properties":{"mon":{"allOf":[{"$ref":"#/components/schemas/LinkedInWorkingDay"}],"description":"One day of a LinkedIn account's working hours. Times are `HH:mm` in the account's time zone."},"tue":{"allOf":[{"$ref":"#/components/schemas/LinkedInWorkingDay"}],"description":"One day of a LinkedIn account's working hours. Times are `HH:mm` in the account's time zone."},"wed":{"allOf":[{"$ref":"#/components/schemas/LinkedInWorkingDay"}],"description":"One day of a LinkedIn account's working hours. Times are `HH:mm` in the account's time zone."},"thu":{"allOf":[{"$ref":"#/components/schemas/LinkedInWorkingDay"}],"description":"One day of a LinkedIn account's working hours. Times are `HH:mm` in the account's time zone."},"fri":{"allOf":[{"$ref":"#/components/schemas/LinkedInWorkingDay"}],"description":"One day of a LinkedIn account's working hours. Times are `HH:mm` in the account's time zone."},"sat":{"allOf":[{"$ref":"#/components/schemas/LinkedInWorkingDay"}],"description":"One day of a LinkedIn account's working hours. Times are `HH:mm` in the account's time zone."},"sun":{"allOf":[{"$ref":"#/components/schemas/LinkedInWorkingDay"}],"description":"One day of a LinkedIn account's working hours. Times are `HH:mm` in the account's time zone."}},"additionalProperties":false,"description":"A LinkedIn account's working hours, one entry per day from `mon` to `sun`, in the account's time zone.\nKenso runs the account's LinkedIn actions only inside these hours. A day with no entry uses the default: 08:00 to\n18:00 on weekdays, closed on weekends. An update must include all seven days."},"LinkedInWorkingDay":{"type":"object","properties":{"open":{"type":"boolean","description":"True when the account works on this day; false when it takes the day off.","nullable":true},"start":{"type":"string","description":"When the working day starts, such as `09:00`.","nullable":true},"end":{"type":"string","description":"When the working day ends, such as `17:30`.","nullable":true}},"additionalProperties":false,"description":"One day of a LinkedIn account's working hours. Times are `HH:mm` in the account's time zone."},"MailProviderCount":{"type":"object","properties":{"slug":{"type":"string","description":"Short id of the gateway or host, such as `proofpoint` or `google_workspace`."},"name":{"type":"string","description":"Display name of the gateway or host."},"count":{"type":"integer","description":"Number of contacts behind it.","format":"int32"}},"additionalProperties":false,"description":"Contacts behind one security gateway or mailbox host."},"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."},"PersonImportJob":{"type":"object","properties":{"source":{"type":"string","description":"Where the rows came from, the import's `source`, such as `csv`, `search` or `google_sheets`."},"createdCount":{"type":"integer","description":"Rows that created a new person.","format":"int32"},"updatedCount":{"type":"integer","description":"Rows that matched a person already in the workspace and updated it. Kenso matches by email, LinkedIn URL, or\nname and company domain.","format":"int32"},"skippedCount":{"type":"integer","description":"Rows Kenso skipped: a row with no email, no LinkedIn URL and no name with a business company domain, or a row\nKenso could not take in.","format":"int32"},"startedAt":{"type":"string","description":"When the import started, in UTC. Omitted while it waits in the queue.","format":"date-time","nullable":true},"completedAt":{"type":"string","description":"When the import finished or failed, in UTC. Omitted until then.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Counts of a contact import with target `people`."},"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."},"RecipientProvider":{"type":"object","properties":{"slug":{"type":"string","description":"Stable short id, such as `google_workspace`, `microsoft_365` or `mimecast`."},"name":{"type":"string","description":"Display name."},"kind":{"type":"string","description":"Provider type: `mailbox_provider` or `security_gateway`."}},"additionalProperties":false,"description":"A mailbox provider or security gateway Kenso recognizes."},"RecipientProviderCount":{"type":"object","properties":{"slug":{"type":"string","description":"Stable short id, such as `google_workspace` or `mimecast`."},"name":{"type":"string","description":"Display name."},"kind":{"type":"string","description":"Provider type: `mailbox_provider` or `security_gateway`."},"leadCount":{"type":"integer","description":"Contacts that can still get an email and sit behind this provider.","format":"int32"}},"additionalProperties":false,"description":"Contacts behind one mailbox provider or security gateway."},"RecipientProviderCounts":{"type":"object","properties":{"providers":{"type":"array","items":{"$ref":"#/components/schemas/RecipientProviderCount"},"description":"Every mailbox provider and security gateway Kenso tracks, including those with 0 contacts, most contacts first.\nA contact counts once under its mailbox provider and once under its security gateway."},"pendingCount":{"type":"integer","description":"Contacts whose provider is still being detected.","format":"int32"},"noProviderCount":{"type":"integer","description":"Contacts whose domain has no known provider, such as self-hosted mail or a domain with no MX record.","format":"int32"},"isPartial":{"type":"boolean","description":"True when more than 100,000 of the campaign's contacts can still get an email; the counts then cover the first\n100,000 by id."}},"additionalProperties":false,"description":"The campaign's contacts behind each mailbox provider and security gateway.","example":{"providers":[{"slug":"google_workspace","name":"Google Workspace","kind":"mailbox_provider","leadCount":1104},{"slug":"microsoft_365","name":"Microsoft 365","kind":"mailbox_provider","leadCount":736},{"slug":"mimecast","name":"Mimecast","kind":"security_gateway","leadCount":87}],"pendingCount":64,"noProviderCount":23,"isPartial":false}},"RecipientProviderCountsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/RecipientProviderCounts"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"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."},"ReplaceCampaignAiWorkflowsRequest":{"required":["aiWorkflowIds"],"type":"object","properties":{"aiWorkflowIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Every workflow id to attach: 1 qualification, 2 personalization, 3 rewriting, 4 segmentation, 6 scoring or\n8 line check. Required. `[]` detaches every workflow."}},"additionalProperties":false,"description":"The AI workflows the campaign should run.","example":{"aiWorkflowIds":[1,2,6]}},"ReplaceCampaignInboxesRequest":{"type":"object","properties":{"inboxIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of the workspace inboxes the campaign should use. Required unless `assignAllActive` or\n`allInboxes` is true.","nullable":true},"assignAllActive":{"type":"boolean","description":"True assigns every inbox in the workspace that can send through Kenso, as a saved list. `inboxIds` is then\nignored."},"provider":{"type":"string","description":"With `assignAllActive`, assigns only inboxes of this kind: `google`, `microsoft`, `azure`\nor `custom_smtp`.","nullable":true},"allInboxes":{"type":"boolean","description":"True makes the campaign use all inboxes: every inbox a launch would assign joins now, and inboxes connected\nlater join too. `inboxIds`, `assignAllActive` and `provider` are then ignored. Needs the sender\nrouting feature. Omitted or false keeps a saved list of the inboxes you send.","nullable":true}},"additionalProperties":false,"description":"The inboxes a campaign sends from.","example":{"inboxIds":[5530,5531,5532],"assignAllActive":false}},"ReplaceCampaignLinkedInAccountsRequest":{"type":"object","properties":{"linkedInAccountIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of the workspace's LinkedIn accounts to assign. Required unless `assignAllConnected` is true.","nullable":true},"assignAllConnected":{"type":"boolean","description":"True assigns every connected LinkedIn account in the workspace. `linkedInAccountIds` is then ignored."}},"additionalProperties":false,"description":"The LinkedIn accounts a campaign uses.","example":{"linkedInAccountIds":[2207],"assignAllConnected":false}},"ReplaceCampaignSenderRouteRule":{"type":"object","properties":{"provider":{"type":"string","description":"Slug of a mailbox provider or security gateway, such as `google_workspace` or `mimecast`.","nullable":true},"domains":{"type":"array","items":{"type":"string"},"description":"Whole sending domains: the part after `@` of a workspace inbox. Inboxes added on them later join the rule.\nSaved in lower case.","nullable":true},"inboxIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of single workspace inboxes.","nullable":true}},"additionalProperties":false,"description":"One rule: contacts on `provider` get their first email only from these domains and inboxes."},"ReplaceCampaignSenderRoutingRequest":{"required":["rules"],"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/ReplaceCampaignSenderRouteRule"},"description":"The rules, at most one per provider. Required."}},"additionalProperties":false,"description":"Every sender routing rule the campaign should have. Send `[]` to clear them.","example":{"rules":[{"provider":"microsoft_365","domains":["outreach.example.net"]}]}},"ReplaceLinkedInSettingsRequest":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"True runs the campaign's LinkedIn steps."},"channelPolicy":{"type":"string","description":"Required: `linkedin_only`, `linkedin_first_email_fallback`, `email_first_linkedin_reinforce`\nor `parallel`. A launched campaign cannot switch to `linkedin_only`.","nullable":true},"notAcceptedAfterDays":{"type":"integer","description":"Days to wait for a connection request to be accepted, from 1 to 90.","format":"int32"},"conditionWaitDays":{"type":"integer","description":"Days a step waits for its condition before it is skipped, from 1 to 60. Omitted or 0 means 14.","format":"int32","nullable":true},"isWithdrawEnabled":{"type":"boolean","description":"True withdraws a connection request that was not accepted within `notAcceptedAfterDays`."},"stopLinkedInOnEmailReply":{"type":"boolean","description":"True stops a contact's LinkedIn steps when they reply by email."},"stopEmailOnLinkedInReply":{"type":"boolean","description":"True stops a contact's emails when they reply on LinkedIn."},"stopSequenceForCompanyOnReply":{"type":"boolean","description":"True stops the sequence for every contact at the same company when one of them replies. Same setting as the\ncampaign's `stopCompanyOnReply`. Omitted keeps the current value.","nullable":true},"stopAllChannelsOnReply":{"type":"boolean","description":"True stops every channel when the contact replies on any channel, also after their LinkedIn steps finished.\nOmitted keeps the current value (true for a campaign with no LinkedIn settings yet).","nullable":true}},"additionalProperties":false,"description":"A campaign's full LinkedIn settings. Every field is written; an omitted boolean is saved as false.","example":{"isEnabled":true,"channelPolicy":"email_first_linkedin_reinforce","notAcceptedAfterDays":21,"conditionWaitDays":14,"isWithdrawEnabled":true,"stopLinkedInOnEmailReply":true,"stopEmailOnLinkedInReply":true,"stopSequenceForCompanyOnReply":true,"stopAllChannelsOnReply":true}},"ReplaceScoringSettingsRequest":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"True turns lead scoring on; false or omitted turns it off."}},"additionalProperties":false,"description":"Turns lead scoring on or off for a campaign.","example":{"isEnabled":true}},"RetryEnrichment":{"type":"object","properties":{"companyStatusesCleared":{"type":"integer","description":"Companies whose website could not be read or had no usable content.","format":"int32"},"scrapeFailuresCleared":{"type":"integer","description":"Website reads that failed.","format":"int32"},"contactStatusesCleared":{"type":"integer","description":"Contacts whose email search failed.","format":"int32"}},"additionalProperties":false,"description":"How many failed enrichment results were cleared so the contacts and companies are tried again.","example":{"companyStatusesCleared":14,"scrapeFailuresCleared":9,"contactStatusesCleared":31}},"RetryEnrichmentResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/RetryEnrichment"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"RunCampaignScoringRequest":{"type":"object","properties":{"contactIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of the contacts to score; only qualified contacts among them are scored. Omit to let Kenso pick up to\n`limit` of the campaign's qualified contacts.","nullable":true},"limit":{"type":"integer","description":"Most contacts to score in this run, from 1 to 1000. Defaults to 100.","format":"int32","nullable":true}},"additionalProperties":false,"description":"Which contacts to score.","example":{"contactIds":[90125,90126]}},"ScoringSettings":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"True when lead scoring is on, which means the scoring AI workflow (id 6) is attached."}},"additionalProperties":false,"description":"Whether lead scoring is on for a campaign.","example":{"isEnabled":true}},"ScoringSettingsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ScoringSettings"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SenderRouteGroup":{"type":"object","properties":{"sendableInboxCount":{"type":"integer","description":"Inboxes in no rule that can send now: they can send through Kenso and are not paused.","format":"int32"},"dailyCapacity":{"type":"integer","description":"Sum of those inboxes' daily send limits, in emails per day.","format":"int32"},"leadCount":{"type":"integer","description":"Contacts that can still get an email and that no rule matches.","format":"int32"}},"additionalProperties":false,"description":"The inboxes no rule claims and the contacts no rule matches."},"SenderRouteRule":{"type":"object","properties":{"provider":{"allOf":[{"$ref":"#/components/schemas/RecipientProvider"}],"description":"The mailbox provider or security gateway the rule matches."},"domains":{"type":"array","items":{"type":"string"},"description":"Whole sending domains, in lower case. Inboxes added on these domains later join the rule."},"inboxIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Ids of single inboxes in the rule."},"sendableInboxCount":{"type":"integer","description":"The campaign's inboxes in the rule that can send now: they can send through Kenso and are not paused.","format":"int32"},"dailyCapacity":{"type":"integer","description":"Sum of those inboxes' daily send limits, in emails per day. An inbox with no limit set counts as 0.","format":"int32"},"leadCount":{"type":"integer","description":"The campaign's contacts that can still get an email and that the rule matches now. Contacts whose provider is\nstill being detected are in no group. At most 100,000 contacts are counted.","format":"int32"}},"additionalProperties":false,"description":"One routing rule, with the inboxes and contacts it covers now."},"SenderRouting":{"type":"object","properties":{"allInboxes":{"type":"boolean","description":"True when the campaign uses all inboxes, so inboxes connected later join it. False when it uses a saved list.\nChange it with `PUT /v1/campaigns/{campaignId}/inboxes`."},"rules":{"type":"array","items":{"$ref":"#/components/schemas/SenderRouteRule"},"description":"The routing rules, sorted by provider name."},"everyoneElse":{"allOf":[{"$ref":"#/components/schemas/SenderRouteGroup"}],"description":"The inboxes no rule claims and the contacts no rule matches."},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/SenderRoutingWarning"},"description":"Problems that would make contacts wait. Empty when there are none."}},"additionalProperties":false,"description":"A campaign's sender routing. Each rule sends the first email to contacts on one mailbox provider or security gateway\nonly from the rule's domains and inboxes. Contacts no rule matches get their first email from the inboxes no rule\nclaims (everyone else). Follow-ups always come from the inbox that sent the first email.","example":{"allInboxes":false,"rules":[{"provider":{"slug":"microsoft_365","name":"Microsoft 365","kind":"mailbox_provider"},"domains":["outreach.example.net"],"inboxIds":[],"sendableInboxCount":2,"dailyCapacity":100,"leadCount":736}],"everyoneElse":{"sendableInboxCount":4,"dailyCapacity":200,"leadCount":1191},"warnings":[{"code":"rule_slow","provider":"microsoft_365","leadCount":736,"days":8}]}},"SenderRoutingResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SenderRouting"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SenderRoutingWarning":{"type":"object","properties":{"code":{"type":"string","description":"The problem. `rule_no_inbox`: none of the rule's inboxes can send, so its contacts wait.\n`everyone_else_no_inbox`: every inbox that can send is in a rule, so contacts no rule matches wait.\n`rule_slow`: the rule needs more than 5 days to reach its contacts at its daily capacity."},"provider":{"type":"string","description":"The rule's provider slug. Omitted for `everyone_else_no_inbox`.","nullable":true},"leadCount":{"type":"integer","description":"Contacts that wait or are slow to reach.","format":"int32","nullable":true},"days":{"type":"integer","description":"For `rule_slow` only: contacts divided by daily capacity, rounded up, in days.","format":"int32","nullable":true}},"additionalProperties":false,"description":"A routing problem that would make contacts wait."},"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."},"SetCampaignLaunchScheduleBody":{"type":"object","properties":{"launchAt":{"type":"string","description":"When to launch, as an ISO 8601 date and time with its offset, such as `2026-11-16T09:00:00+01:00` or\n`2026-11-16T08:00:00Z`. At least 5 minutes and at most 90 days from now.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"When to launch a campaign.","example":{"launchAt":"2026-10-19T13:00:00Z"}},"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."},"UpdateCampaignAgentWorkBody":{"type":"object","properties":{"settings":{"type":"array","items":{"$ref":"#/components/schemas/UpdateCampaignAgentWorkEntry"},"description":"One entry per kind to change, each kind at most once. At least one entry.","nullable":true}},"additionalProperties":false,"description":"The PATCH body: the kinds whose override changes. Kinds you leave out stay as they are.","example":{"settings":[{"kind":"personalization","executor":"my_agent"}]}},"UpdateCampaignAgentWorkEntry":{"type":"object","properties":{"kind":{"type":"string","description":"`personalization`. Any other kind answers `validation_failed`.","nullable":true},"executor":{"type":"string","description":"`kenso_ai`, `my_agent`, or null to clear the override so the campaign follows its workspace.","nullable":true}},"additionalProperties":false,"description":"One kind and the campaign's new override."},"UpdateCampaignRequest":{"type":"object","properties":{"name":{"type":"string","description":"New display name. It cannot be blank.","nullable":true},"contactLimit":{"type":"integer","description":"New contact limit, greater than 0.","format":"int32","nullable":true},"status":{"type":"string","description":"Always rejected: change the status with the launch, pause, resume, restart and archive actions instead.","nullable":true},"sendingDays":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Days to send on, from 0 (Sunday) to 6 (Saturday). Cannot be empty.","nullable":true},"sendingStartTime":{"type":"string","description":"Start of the daily sending window, as a time such as `09:30`.","nullable":true},"sendingEndTime":{"type":"string","description":"End of the daily sending window, as a time such as `18:00`.","nullable":true},"sendingTimezone":{"type":"string","description":"Time zone of the sending window: a supported IANA name such as `America/New_York`, or `prospect` to\nsend in each contact's own time zone.","nullable":true},"maxEmailsPerDay":{"type":"integer","description":"Most emails the campaign sends per day, greater than 0.","format":"int32","nullable":true},"ownerMemberId":{"type":"integer","description":"Member id of the new campaign owner, who must be an active member of the workspace. Null or omitted keeps the\ncurrent owner; the owner cannot be cleared.","format":"int64","nullable":true},"stopOnReply":{"type":"boolean","description":"True stops a contact's sequence on any reply; false lets neutral and positive replies continue it. Changing this\nor the other sending switches needs the campaign send settings feature; sending the current value is always\naccepted.","nullable":true},"trackClicks":{"type":"boolean","description":"True sends links through tracking links. Same feature rule as `stopOnReply`.","nullable":true},"trackOpens":{"type":"boolean","description":"Always false: campaign emails never carry an open-tracking pixel. Opens are not tracked and are never reported.\n`true` is refused with `400 validation_failed`, detail code `open_tracking_unavailable`; `false`\nis accepted and needs no feature.","nullable":true},"unsubscribeLink":{"type":"boolean","description":"True adds the `List-Unsubscribe` headers to every email; false drops them from steps that carry the\n`{{unsubscribe_link}}` link. Same feature rule as `stopOnReply`.","nullable":true},"sendAsPlainText":{"type":"boolean","description":"True sends emails written as HTML as plain text only, with no HTML part. Steps with a drawn handwritten letter, a\nvideo, a Studio email, a provider-built message or any image in the sent body (a signature logo counts) keep their\nHTML, decided per send. Omit (or send null) to leave it unchanged. Unlike `stopOnReply`, changing it needs no\nfeature. Turning it on is refused (`open_tracking_off`) while the campaign's sequence with conditions branches\non an opened email.","nullable":true},"protectAccountPlays":{"type":"boolean","description":"True skips people in active account plays. Turning it off does not restart people already stopped.","nullable":true},"rampUpDays":{"type":"integer","description":"Ramp-up length in scheduled sending days, from 0 (no ramp) to 30.","format":"int32","nullable":true},"stopCompanyOnReply":{"type":"boolean","description":"True stops every contact at the same company when one replies. Same setting as\n`stopSequenceForCompanyOnReply` in the LinkedIn settings.","nullable":true},"groupSameCompanySends":{"type":"boolean","description":"True sends to contacts at the same company on the same day.","nullable":true},"newLeadsFirst":{"type":"boolean","description":"True gives first emails the campaign's daily capacity ahead of follow-ups, from the next scheduling pass. While\nit is on, the response carries `awaitingFirstEmailCount`.","nullable":true},"warmStart":{"type":"boolean","description":"True sends the campaign's first emails to its highest-scored contacts first, at a low daily volume, for its first\ndays after launch (14 by default). The window counts from launch: turned on inside it, the lower volume starts that\nday; turned on after it, nothing changes. Turning it on needs warm start enabled for the workspace: otherwise it is\nrefused with `validation_failed` and detail `feature_disabled` on `warmStart`. False is always\naccepted.","nullable":true},"catchAllLaneEnabled":{"type":"boolean","description":"True opts the campaign in to the catch-all lane, false opts it out. It has no effect until Kenso turns the lane\non for all workspaces. `catchAllLanePausedAt` is set by Kenso and cannot be sent.","nullable":true},"emailVerifiers":{"type":"array","items":{"type":"string"},"description":"The verifiers that check the campaign's emails, replacing the saved list: any of `kenso` (Kenso's own\nmailbox check), `leadmagic` (LeadMagic catch-all), `findymail`, `zerobounce` and `neverbounce`, at least one.\nKenso's verifiers run first, in the order Kenso picks, then `zerobounce`, then `neverbounce`, each only\nfor the emails the ones before it left undecided, whatever order you send.\n`zerobounce` and `neverbounce` run on the workspace's own ZeroBounce or NeverBounce key and spend its\ncredits, never Kenso's; adding one the workspace has no working key for is refused (`provider_key_missing`).\nA list of only `zerobounce` or `neverbounce` leaves an email unverified while that key cannot be used\n(cooling down after a rate limit, or refused): list one of Kenso's verifiers too to keep checking emails then.\nNo campaign gets them unless it lists them. Omit to keep the saved list.","nullable":true},"bookingMeetingTypeId":{"type":"integer","description":"Id of an enabled round robin meeting type in this workspace that takes the campaign's bookings when the account\nowner and the sender cannot. Null clears it.","format":"int64","nullable":true},"replyTo":{"type":"string","description":"Reply-To address for this campaign, used instead of the workspace's. It must be a mailbox connected to this\nworkspace that Kenso reads replies from, not a member's own mailbox. Null clears it, so the campaign uses the\nworkspace's setting.","nullable":true},"excludedCountries":{"type":"array","items":{"type":"string"},"description":"Countries this campaign never sends to, as ISO 3166-1 alpha-2 codes or country names, such as `DE` or\n`Germany`. Replaces the saved list; `[]` clears it and null keeps it.","nullable":true},"kind":{"type":"string","description":"Always rejected with detail code `kind_immutable`: the kind is set when the campaign is created.","nullable":true},"roleId":{"type":"integer","description":"Id of the main role a recruiting campaign hires for, a role in this workspace. Null clears it. Needs the\nrecruiting feature, and is rejected on a sales campaign.","format":"int64","nullable":true},"sourceLanguage":{"type":"string","description":"Language the steps are written in: a market locale such as `fr-FR`, or a language such as `en`. This\nand the other language settings need the multilingual outreach feature.","nullable":true},"languageMode":{"type":"string","description":"How each email's language is picked: `source_only` or `auto`.","nullable":true},"enabledLanguages":{"type":"array","items":{"type":"string"},"description":"Market locales to translate into. Replaces the saved list; null or `[]` clears it.","nullable":true},"formalityOverrides":{"type":"object","additionalProperties":{"type":"string"},"description":"Tone per locale, `formal` or `informal`. Replaces the saved map; null or `{}` clears it.","nullable":true},"languageFallback":{"type":"string","description":"What `auto` does when a contact's language has no approved translation: `source` or `hold`.","nullable":true},"mode":{"type":"string","description":"How contacts enter the campaign: `batch` or `trigger`. `trigger` turns a batch campaign into a\ntrigger campaign; the reverse is rejected.","nullable":true},"autoLaunchWhenReady":{"type":"boolean","description":"True launches the campaign by itself once it is ready. Needs the `launch` permission, and is rejected once\nthe campaign has launched or auto-launch has already run.","nullable":true}},"additionalProperties":false,"description":"Changes to a campaign. Send only the fields to change; omitted fields stay as they are. A field this type does not\nlist is rejected with `400`.","example":{"sendingDays":[1,2,3,4],"sendingStartTime":"08:30","sendingEndTime":"16:30","sendingTimezone":"America/Chicago","maxEmailsPerDay":400,"rampUpDays":7}},"UsedBy":{"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/UsedByCampaign"},"description":"The live campaigns (scheduled, launching or sending) that use this inbox or LinkedIn account, ordered by id.\nEmpty when there are none."},"accounts":{"type":"boolean","description":"True when Accounts uses it for one-to-one outreach. An inbox counts when it is its member's primary inbox\n(`isPrimary`). A LinkedIn account counts when the member who connected it owns at least one live account\nin Accounts, because an account's LinkedIn steps go out from the LinkedIn account its owner connected.","nullable":true}},"additionalProperties":false,"description":"What an inbox or LinkedIn account is used for: the live campaigns that send through it, and whether Accounts\nuses it for one-to-one outreach."},"UsedByCampaign":{"type":"object","properties":{"id":{"type":"integer","description":"The campaign id.","format":"int64"},"name":{"type":"string","description":"The campaign's name."},"status":{"type":"string","description":"The campaign's status, with the same values as `GET /v1/campaigns`."}},"additionalProperties":false,"description":"A live campaign that uses an inbox or LinkedIn account."},"WorkflowReadiness":{"type":"object","properties":{"canStart":{"type":"boolean","description":"True when every check passed."},"checks":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowReadinessCheck"},"description":"Every check that applies to the campaign, passed or not."}},"additionalProperties":false,"description":"Whether a campaign's enrichment, email verification and AI workflows can start. Launch readiness, which covers\nsending, is separate.","example":{"canStart":false,"checks":[{"code":"contacts_imported","message":"Campaign must have imported contacts before processing can start.","isPassed":true},{"code":"campaign_name_configured","message":"Campaign name is required before processing can start.","isPassed":true},{"code":"ai_variables_resolved","message":"All AI variables used in email copy must map to prompts that produce output at runtime before processing can start.","isPassed":false}]}},"WorkflowReadinessCheck":{"type":"object","properties":{"code":{"type":"string","description":"The check: `contacts_imported`, `trigger_definitions_configured`, `email_sequence_configured`,\n`email_sequence_versions_unique`, `ai_variables_resolved`, `campaign_name_configured`,\n`contact_limit_configured` or `sending_schedule_configured`. New codes may be added."},"message":{"type":"string","description":"Explanation of the check's result, ready to show to a person."},"isPassed":{"type":"boolean","description":"True when the check passed."}},"additionalProperties":false,"description":"One readiness check and its result."},"WorkflowReadinessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/WorkflowReadiness"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."}}}}