{"openapi":"3.0.4","info":{"title":"Kenso API: LinkedIn sequences","version":"1.1","description":"The LinkedIn sequences 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":"sequences","description":"A sequence is the series of steps Kenso sends to each contact in a campaign: an email sequence holds the emails, and a LinkedIn sequence holds LinkedIn actions timed around those emails. A campaign has one of each, and each segment can have its own, so a segment without its own sequence sends the campaign's. Read and replace either sequence, delete an email sequence, and list the variables subjects and bodies can use with `GET /v1/sequence-variables`. Preview and test send show what a contact will get, and saved versions keep copies you can restore later.","x-displayName":"Sequences"}],"paths":{"/v1/campaigns/{campaignId}/linkedin-sequence":{"get":{"tags":["sequences"],"summary":"Get a campaign's LinkedIn sequence","description":"Returns the steps of the campaign's own LinkedIn sequence. Contacts in a segment without LinkedIn steps of its\nown get these steps. A campaign with no LinkedIn steps returns an empty `steps` list.\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":"linkedin-sequences.get","parameters":[{"name":"campaignId","in":"path","description":"The campaign's id.","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/LinkedInSequenceResponse"}}}},"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":["sequences"],"summary":"Replace a campaign's LinkedIn sequence","description":"Replaces every step of the campaign's own LinkedIn sequence with the steps you send. Kenso deletes the steps you\nleave out, and an empty `steps` list removes them all.\n            \nSteps that share a `stepOrder` are variants `a` to `d` of one step, and each step order needs a variant `a`.\nThe step type, timing and condition come from variant `a`. The text, `name`, `isActive`, `noteMode` and\n`aiInstructions` are set per variant. Profile visits and engagement steps (`follow`, `like_post`,\n`endorse_skill` and `comment_post`) cannot have variants.\n            \nWhen the campaign's email sequence has steps, `anchorEmailStepOrder` must name one of them. When the workspace\nneeds client approval of copy, the change goes to the client, and Kenso pauses a sending campaign until the\nclient approves it.\n            \nErrors:\n            \n- `400 validation_failed`: a step breaks a rule above or a field rule, or uses a variable Kenso does not know.\n- `400 validation_failed`: a step needs a feature that is off for the workspace: `linkedin_engagement` for engagement steps, `linkedin_voice_notes` for `voice_note` steps, or `linkedin_ai_notes` for `noteMode` `ai`.\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":"linkedin-sequences.replace","parameters":[{"name":"campaignId","in":"path","description":"The campaign's id.","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/ReplaceLinkedInSequenceRequest"}}}},"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/LinkedInSequenceResponse"}}}},"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-sequence/versions":{"get":{"tags":["sequences"],"summary":"List a campaign's LinkedIn sequence versions","description":"Returns the saved versions of the campaign's own LinkedIn sequence, newest first. Kenso adds a version when you\nsave one or restore one. Replacing the sequence does not add a version.\n            \nErrors:\n            \n- `400 validation_failed`: `limit` is out of range, or `cursor` is invalid.\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":"linkedin-sequences.list-versions","parameters":[{"name":"campaignId","in":"path","description":"The campaign's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Versions per page, from 1 to 100. Defaults to 20.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"cursor","in":"query","description":"The `nextCursor` from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"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/SequenceVersionListResponse"}}}},"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":["sequences"],"summary":"Save a campaign's LinkedIn sequence version","description":"Saves a version of the campaign's own LinkedIn sequence that you can restore later. The call does not change the\nlive steps.\n            \nWithout `sourceVersionId`, the version is a copy of the live steps, and Kenso does not store the `steps` you\nsend. With `sourceVersionId`, the version starts from that saved version, and a non-empty `steps` list replaces\nits steps. A connection request sent without `noteMode` keeps the mode of the same step and variant in that\nversion.\n            \nKenso checks any `steps` you send with the rules of `PUT /v1/campaigns/{campaignId}/linkedin-sequence`,\nbecause a restore makes them live.\n            \nErrors:\n            \n- `400 validation_failed`: a step breaks a LinkedIn sequence rule, or needs a feature that is off for the workspace.\n- `404 not_found`: the campaign does not exist in this workspace, or `sourceVersionId` is not one of its LinkedIn sequence's versions.\n- `409 conflict`: another version save for this sequence is running. Retry shortly.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"linkedin-sequences.save-version","parameters":[{"name":"campaignId","in":"path","description":"The campaign's id.","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/SaveLinkedInVersionRequest"}}}},"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/LinkedInSequenceVersionSaveResponse"}}}},"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","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/campaigns/{campaignId}/linkedin-sequence/versions/{versionId}":{"get":{"tags":["sequences"],"summary":"Get a campaign's LinkedIn sequence version","description":"Returns one saved version with a copy of the LinkedIn steps as they were saved.\n            \nErrors:\n            \n- `404 not_found`: the campaign does not exist in this workspace, or the version is not one of its LinkedIn sequence's versions.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"linkedin-sequences.get-version","parameters":[{"name":"campaignId","in":"path","description":"The campaign's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"versionId","in":"path","description":"The version's id, from the list of versions.","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/LinkedInSequenceVersionDetailResponse"}}}},"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}/linkedin-sequence/versions/{versionId}/restore":{"post":{"tags":["sequences"],"summary":"Restore a campaign's LinkedIn sequence version","description":"Writes the steps of a saved version into the campaign's live LinkedIn sequence and adds a new version that\nrecords the restore. `newVersionNumber` in the response is that version's number.\n            \nErrors:\n            \n- `400 validation_failed`: the version has no steps while the live sequence has some, a step breaks today's LinkedIn sequence rules, or a step needs a feature that is off for the workspace.\n- `404 not_found`: the campaign does not exist in this workspace, or the version is not one of its LinkedIn sequence's versions.\n- `409 conflict`: another version save for this sequence is running. Retry shortly.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"linkedin-sequences.restore-version","parameters":[{"name":"campaignId","in":"path","description":"The campaign's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"versionId","in":"path","description":"The id of the version to restore.","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/SequenceRestoreResponse"}}}},"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","summary":"Campaigns edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Enter: Bearer {your Kenso API key}. Create one in the Kenso app under Settings > Integrations > API Keys.","scheme":"bearer","bearerFormat":"Opaque API key"}},"headers":{"RateLimit-Limit":{"description":"The request limit of the rate limit this request is closest to reaching: your plan's limit for this kind of call, your API key's own limit, or the operation's own limit, whichever has the fewest requests left.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The requests left under that limit. `0` on a `429`.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"The seconds until that limit resets.","schema":{"type":"integer"}}},"schemas":{"ApiKeyError":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A sentence for people that says what went wrong. It can change, so do not parse it."}},"additionalProperties":false,"description":"The body the API key check in front of the operations answered until November 2026, instead of the error body (`Failure`): `{ \"error\": \"Invalid or revoked API key\" }` on a `401`, `{ \"error\": \"Rate limit exceeded\" }` on a `429` and `{ \"error\": \"Authentication is temporarily unavailable\" }` on a `503`. It has no `code`, so branch on the HTTP status."},"ErrorAccount":{"type":"object","properties":{"accountId":{"type":"integer","description":"The account's id.","format":"int64"},"name":{"type":"string","description":"The account's name."},"stakeholderId":{"type":"integer","description":"The person's stakeholder id on this account.","format":"int64"}},"additionalProperties":false,"description":"An account named in an error detail."},"ErrorBody":{"type":"object","properties":{"code":{"type":"string","description":"Stable error code, such as `validation_failed` or `not_found`. Branch on this value."},"message":{"type":"string","description":"A sentence for people that explains the error. It can change, so do not parse it."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"One entry per problem, naming the field or limit it is about. Omitted when there are none.","nullable":true},"requestId":{"type":"string","description":"The id of this request: the same value as the `X-Correlation-Id` response header. Quote it when you write\nto contact@ken.so."},"docUrl":{"type":"string","description":"The page on this code in the developer docs, which says what it means and how to fix it. The errors guide for a\ncode that has no page of its own.","readOnly":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"On a `402`, the plan rule or usage limit that refused the request and how to lift it. Omitted otherwise."},"impact":{"allOf":[{"$ref":"#/components/schemas/InvalidationImpact"}],"description":"On a `409` that refuses a change because it would clear stored AI output (a prompt edit, a restore or a\nreset), how much the change would clear. Omitted otherwise."},"surface":{"type":"string","description":"Set only by the voice ticket's `409` (code `voice_conversation_active`): the chat the person's other\nvoice conversation runs in, `support`, `ken` or `onboarding`. Omitted on every other error.","nullable":true}},"additionalProperties":false,"description":"What went wrong in a request."},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The request field, header or limit the problem is about, such as `name` or `Ken-Version`."},"code":{"type":"string","description":"Stable code for this problem, such as `required` or `invalid`."},"message":{"type":"string","description":"A sentence for people that explains this problem."},"count":{"type":"integer","description":"On `export_limit_exceeded`, how many rows match the export. Omitted otherwise.","format":"int32","nullable":true},"index":{"type":"integer","description":"The position of the refused item in the request's list. Omitted otherwise.","format":"int32","nullable":true},"limit":{"type":"integer","description":"On `export_limit_exceeded`, the row limit the export ran with. On a `quota_exceeded` detail whose\n`field` names a quota, that quota's limit. On a `rate_limited` detail from your workspace's rate\nlimits, the limit that was hit. Omitted otherwise.","format":"int32","nullable":true},"resetAt":{"type":"string","description":"On some `quota_exceeded` details, when the quota frees up, in UTC. It is the same instant as the top-level\n`quotaResetAt`. On a `rate_limited` detail from your workspace's rate limits, when that limit resets.\nOmitted otherwise.","format":"date-time","nullable":true},"retryAfterSeconds":{"type":"integer","description":"On those `quota_exceeded` details and on most `rate_limited` details, the seconds to wait. It is the\nsame value as the `Retry-After` header. Omitted otherwise.","format":"int32","nullable":true},"inboxId":{"type":"integer","description":"The inbox the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainId":{"type":"integer","description":"The domain the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The name of that domain, or the domain name the request gave. Omitted otherwise.","nullable":true},"accountId":{"type":"integer","description":"On `domain_taken`, `already_stakeholder` and `previously_removed`, the existing account to use\ninstead. Omitted otherwise.","format":"int64","nullable":true},"personId":{"type":"integer","description":"On `email_taken` and `linkedin_url_taken`, the existing person to use instead. Omitted otherwise.","format":"int64","nullable":true},"stakeholderId":{"type":"integer","description":"The account stakeholder the problem is about. Omitted otherwise.","format":"int64","nullable":true},"championId":{"type":"integer","description":"Not used. Always omitted.","format":"int64","nullable":true},"callTaskId":{"type":"integer","description":"On `call_task_exists`, the open call task that already holds the person's slot. Omitted otherwise.","format":"int64","nullable":true},"status":{"type":"string","description":"On `invalid_transition`, the current status. Omitted otherwise.","nullable":true},"allowed":{"type":"array","items":{"type":"string"},"description":"On `out_of_range`, the allowed values. On `invalid_transition`, the statuses the change is allowed\nfrom. Omitted otherwise.","nullable":true},"scope":{"type":"string","description":"On a `permission_denied` for an account owner change, the account scope the call needs (`all`). On\n`sending_paused`, what the pause covers: `inbox`, `domain` or `workspace`. Omitted otherwise.","nullable":true},"removedAt":{"type":"string","description":"On `previously_removed`, when a person removed the stakeholder, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"page":{"type":"string","description":"On `permission_denied`, the page the call needs, such as `campaigns`. Omitted otherwise.","nullable":true},"required":{"type":"string","description":"On `permission_denied`, the access `page` needs: `view` or `edit`. Omitted otherwise.","nullable":true},"feature":{"type":"string","description":"On `permission_denied`, the permission the call needs, such as `launch`. Omitted otherwise.","nullable":true},"runId":{"type":"integer","description":"On `committee_run_active` and `run_not_finding`, the committee run the problem is about. Omitted\notherwise.","format":"int64","nullable":true},"mergedIntoId":{"type":"integer","description":"On `person_merged`, the person the merged person now lives on. On `account_merged`, the account the\nmerged account now lives on. Omitted otherwise.","format":"int64","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAccount"},"description":"On `person_on_accounts`, the accounts that block the change. Omitted otherwise.","nullable":true},"stage":{"type":"string","description":"On `stage_in_use` and `system_stage`, the opportunity stage key the problem is about. Omitted otherwise.","nullable":true},"opportunityCount":{"type":"integer","description":"On `stage_in_use`, how many opportunities are in that stage. Omitted otherwise.","format":"int32","nullable":true},"rule":{"type":"string","description":"On `guardrail_violation`, the contact limit rule the change breaks. Omitted otherwise.","nullable":true},"nextAllowedAt":{"type":"string","description":"On `guardrail_violation`, the first `dueAt` that passes every contact limit, in UTC. On a refused\nsend, when to retry. Omitted otherwise, and when waiting does not clear it.","format":"date-time","nullable":true},"fix":{"type":"string","description":"On a refused send, what to do next, in plain words. Omitted otherwise.","nullable":true},"opensAt":{"type":"string","description":"On `outside_calling_hours`, when the person's calling window opens, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"On a knowledge file's `version_conflict`, the file's current version. Omitted otherwise.","format":"int32","nullable":true},"provider":{"type":"string","description":"On a CRM connection error (`provider_error`, `exchange_failed`, `already_connected`,\n`account_mismatch` or `provider_unavailable`), the CRM it is about. Omitted otherwise.","nullable":true},"sharedWithMaster":{"type":"boolean","description":"True on a `quota_exceeded` detail when the shared limit of the white-label master workspace was hit, so\n`limit` is the limit of the whole white-label account. Omitted otherwise. The master's id is never sent.","nullable":true},"stepId":{"type":"integer","description":"On `link_reputation_blocked`, the saved sequence step that holds the blocked link. Omitted otherwise, and\nfor a step the save would have created.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"On `link_reputation_blocked`, the `stepOrder` of that step. Omitted otherwise.","format":"int32","nullable":true},"url":{"type":"string","description":"On `link_reputation_blocked`, the blocked link as the step's copy writes it. Omitted otherwise.","nullable":true},"key":{"type":"string","description":"On `unfilled_template_key`, the template key the text still holds, such as `first_name` for\n`{first_name}`. Omitted otherwise.","nullable":true},"marker":{"type":"string","description":"On `unfilled_template_key`, that key as the text writes it, such as `{first_name}` or `[company]`.\nOmitted otherwise.","nullable":true},"retryAt":{"type":"string","description":"On a warm path Start's `guardrail_connector_monthly`, `guardrail_account_monthly`,\n`guardrail_connector_cooldown` and `guardrail_handoff_weekly`, when the limit frees up, in UTC. Omitted\notherwise.","format":"date-time","nullable":true},"workspaceId":{"type":"integer","description":"On `last_admin`, a workspace that needs a new admin before the account can be deleted. On\n`new_admin_not_found`, the workspace of the refused choice. Omitted otherwise.","format":"int64","nullable":true},"workspaceName":{"type":"string","description":"On `last_admin`, the name of that workspace. Omitted otherwise.","nullable":true},"class":{"type":"string","description":"On a `rate_limited` detail from your workspace's rate limits, the class of call that hit its limit:\n`read`, `write`, `bulk`, `heavy` or `sensitive`. Omitted otherwise.","nullable":true},"window":{"type":"string","description":"On that detail, the window whose limit was hit: `minute`, `day` or `bulkItemsDay`. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One problem in an error: the field or limit it is about, a stable `code` and a `message`. The other fields\nappear only with the codes their descriptions name."},"Failure":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on an error."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"What went wrong."},"quotaResetAt":{"type":"string","description":"When the quota that refused the request frees up, in UTC. Set on some quota refusals. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"The current revision of a workflow draft, on a draft save's `409 version_conflict`. Read the workflow\nagain, then send this value as `baseVersion`. Omitted otherwise.","format":"int32","nullable":true},"current":{"allOf":[{"$ref":"#/components/schemas/MeetingRepNotesCurrent"}],"description":"Your meeting notes and their version as stored now, on a meeting notes save's `409 version_conflict`.\nMerge your change, then save again with `baseVersion` set to `current.repNotesVersion`. Omitted\notherwise."},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"A copy of `error.refusal`, set on some billing refusals. Omitted otherwise."},"message":{"type":"string","description":"A copy of `error.message`, set together with `refusal`. Omitted otherwise.","nullable":true},"lookalikeSeeds":{"description":"How Kenso read each seed of a lookalike search, on its `422 no_usable_seeds`:\n`{resolved: [{input, companyId, personId, name, domain}], unresolved: [{input, reason}]}`. Use it to show\nwhy no seed was usable. Omitted otherwise."}},"additionalProperties":false,"description":"The body of every error, with a 4xx or 5xx status. Branch on `error.code`."},"InvalidationImpact":{"type":"object","properties":{"qualificationResponses":{"type":"integer","description":"Stored qualification answers the change would clear.","format":"int32"},"qualifiedFlags":{"type":"integer","description":"Contacts whose qualified result the change would clear.","format":"int32"},"segmentationReasoning":{"type":"integer","description":"Stored segmentation explanations the change would clear.","format":"int32"},"segmentationAssignmentsKept":{"type":"integer","description":"Contacts that keep their segment.","format":"int32"},"segmentationAssignmentsReset":{"type":"integer","description":"Contacts that go back to the default segment.","format":"int32"},"personalizationLines":{"type":"integer","description":"Personalized lines the change would clear.","format":"int32"},"personalizationLeads":{"type":"integer","description":"Contacts that would lose their personalized lines.","format":"int32"},"rewritingLines":{"type":"integer","description":"Rewritten lines the change would clear.","format":"int32"},"rewritingLeads":{"type":"integer","description":"Contacts that would lose their rewritten lines.","format":"int32"}},"additionalProperties":false,"description":"How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it\nkeeps or resets."},"LinkedInSequence":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The id of the campaign the sequence belongs to.","format":"int64"},"segmentId":{"type":"integer","description":"The id of the segment that owns the sequence. Null for the campaign's own sequence.","format":"int64","nullable":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/LinkedInSequenceStep"},"description":"Every step and variant of the sequence, in step order. Empty when there are no LinkedIn steps."},"connectionNoteMaxChars":{"type":"integer","description":"The longest written connection note (`body` of a `connection_request` step) Kenso saves for this campaign: 200 when\na LinkedIn account in the campaign's sender pool has no Premium, since LinkedIn takes at most 200 characters in a\nnote from such an account, else 275. A longer note is refused with `400 validation_failed`.","format":"int32"}},"additionalProperties":false,"description":"The LinkedIn steps Kenso runs for each contact of a campaign or segment, timed around the emails.","example":{"campaignId":4821,"steps":[{"stepOrder":1,"stepType":"connection_request","variant":"a","body":"Hi {firstName}, I work with engineering leaders on onboarding. Glad to connect.","waitDays":1,"anchorEmailStepOrder":1,"positionInGap":0,"conditionType":"none","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"noteMode":"template","id":9301,"requiresApproval":false,"warnings":[]},{"stepOrder":2,"stepType":"message","variant":"a","body":"Thanks for connecting, {firstName}. Did my email about onboarding new engineers reach you?","waitDays":2,"anchorEmailStepOrder":1,"positionInGap":1,"conditionType":"accepted","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"id":9302,"requiresApproval":false,"warnings":[]}],"connectionNoteMaxChars":200}},"LinkedInSequenceResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/LinkedInSequence"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"LinkedInSequenceSnapshotStep":{"type":"object","properties":{"stepOrder":{"type":"integer","description":"The step's position in the LinkedIn sequence. Variants of one step share it.","format":"int32"},"stepType":{"type":"string","description":"The action: `profile_visit`, `connection_request`, `message`, `in_mail`, `follow`, `like_post`,\n`endorse_skill`, `comment_post` or `voice_note`."},"variant":{"type":"string","description":"The variant: `a`, `b`, `c` or `d`."},"name":{"type":"string","description":"A label for the variant. Kenso does not send it to LinkedIn. Omitted when it has none.","nullable":true},"subject":{"type":"string","description":"The InMail subject line. Omitted when empty.","nullable":true},"body":{"type":"string","description":"The text of the step, such as the connection request note or the message. Omitted when empty.","nullable":true},"waitDays":{"type":"integer","description":"Days Kenso waits before it runs the step, counted from the send of the anchor email, or from when the contact\nentered the LinkedIn sequence when `anchorEmailStepOrder` is 0.","format":"int32"},"anchorEmailStepOrder":{"type":"integer","description":"The `stepOrder` of the email step this step follows. 0 places it before the first email.","format":"int32"},"positionInGap":{"type":"integer","description":"The step's order among the LinkedIn steps that follow the same email, from 0.","format":"int32"},"conditionType":{"type":"string","description":"What the contact must have done before the step runs: `none`, `clicked` (clicked an email link),\n`replied_positive` (replied with interest), `accepted` (accepted the invite or is already connected) or\n`engaged` (read or reacted to a LinkedIn message). Kenso skips the step when the condition is not met in time."},"conditionScopeStepOrder":{"type":"integer","description":"For `clicked`, the `stepOrder` of the email whose link the contact must click. Omitted means any email so far.","format":"int32","nullable":true},"isOptional":{"type":"boolean","description":"True when Kenso skips the step once the next email after its anchor is sent."},"openProfileOnly":{"type":"boolean","description":"True when a message that falls back to a free InMail goes only to open profiles, and other contacts skip it."},"waitFromCondition":{"type":"boolean","description":"True when the step's wait counted from the moment its accepted or not-accepted condition came true."},"isActive":{"type":"boolean","description":"Whether the variant was on."},"noteMode":{"type":"string","description":"For a connection request: `template` sends `body` as the note, and `ai` has Ken write each note."},"aiInstructions":{"type":"string","description":"What Ken should write in each note when `noteMode` is `ai`, at most 1,000 characters. Omitted when empty.","nullable":true},"voice":{"allOf":[{"$ref":"#/components/schemas/VoiceNoteSettings"}],"description":"The voice settings of a `voice_note` step. Omitted on every other step."},"requiresApproval":{"type":"boolean","description":"For a `like_post`, `endorse_skill` or `comment_post` step, whether each action waited for a person's approval.\nOmitted on every other step, and in versions saved before Kenso recorded it.","nullable":true}},"additionalProperties":false,"description":"One LinkedIn step and variant in a saved version."},"LinkedInSequenceStep":{"type":"object","properties":{"id":{"type":"integer","description":"The step's id. Send it back in a replace to update this step.","format":"int64"},"stepOrder":{"type":"integer","description":"The step's position in the LinkedIn sequence, starting at 1. The variants of one step share it.","format":"int32"},"stepType":{"type":"string","description":"What the step does: `profile_visit`, `connection_request`, `message`, `voice_note`, `follow`, `like_post`,\n`endorse_skill` or `comment_post`. Older steps can read `in_mail`."},"variant":{"type":"string","description":"The variant of the step for A/B testing: `a`, `b`, `c` or `d`.","nullable":true},"name":{"type":"string","description":"A label for the variant. LinkedIn never shows it. Null when none is set.","nullable":true},"subject":{"type":"string","description":"The subject Kenso uses when a `message` or `voice_note` step goes out as an InMail. Null when none is set.","nullable":true},"body":{"type":"string","description":"The text of the step. It is the note of a `connection_request`, the message of a `message`, the text Kenso\nsends when a `voice_note` cannot go, and guidance for the comment Ken writes on a `comment_post`. Other step\ntypes have no body.","nullable":true},"waitDays":{"type":"integer","description":"Days Kenso waits before the step. They count from when the anchor email is sent, or from when the contact\nentered the LinkedIn sequence when `anchorEmailStepOrder` is 0.","format":"int32"},"anchorEmailStepOrder":{"type":"integer","description":"The `stepOrder` of the email step this step follows. 0 places it before the first email.","format":"int32"},"positionInGap":{"type":"integer","description":"The step's order among the LinkedIn steps that follow the same email. Lower numbers run first.","format":"int32"},"conditionType":{"type":"string","description":"What must happen before the step runs: `none`, `clicked` (the contact clicked a link in an email),\n`replied_positive` (the contact replied with interest), `accepted` (the contact accepted the invitation or is\nalready connected) or `engaged` (the contact read or reacted to a LinkedIn message). When the condition is not\nmet within its waiting window, Kenso skips the step."},"conditionScopeStepOrder":{"type":"integer","description":"For a `clicked` condition, the `stepOrder` of the email whose link must be clicked. Null means a link in any\nemail sent so far.","format":"int32","nullable":true},"isOptional":{"type":"boolean","description":"Whether Kenso skips the step once the next email after its anchor email is sent."},"openProfileOnly":{"type":"boolean","description":"When a `message` step goes out as a free InMail, whether Kenso sends it only to open profiles and skips the\nothers."},"waitFromCondition":{"type":"boolean","description":"With an `accepted` or `not_accepted` condition, true counts `waitDays` from the moment the condition came true\n(the contact accepted, or the invite expired), so a 1-day wait means one day after they connect."},"isActive":{"type":"boolean","description":"Whether Kenso runs this variant. An inactive variant is kept but not run."},"noteMode":{"type":"string","description":"How a `connection_request` gets its note: `template` sends `body`, and `ai` has Ken write a note for each\ncontact. Other step types read `template`."},"aiInstructions":{"type":"string","description":"Your instructions to Ken for writing the notes of a `connection_request` with `noteMode` `ai`. Null when none\nare set.","nullable":true},"voice":{"allOf":[{"$ref":"#/components/schemas/VoiceNoteSettings"}],"description":"The voice settings of a `voice_note` step. Null on every other step type."},"requiresApproval":{"type":"boolean","description":"Whether Kenso asks a person before it acts: on a `like_post`, `endorse_skill` or `comment_post` step, true holds\neach like, endorsement or comment in Approvals, with the exact comment or the post or skill, until someone approves\nit. False on every other step type, and on one of these steps when the owner turned it off."},"warnings":{"type":"array","items":{"type":"string"},"description":"Advice about this step that never stops a save. `unfilled_token:<name>` means the body, or the InMail subject,\nholds a `{{name}}` that nothing fills: it is no campaign variable, it has no inline fallback (`{{name|text}}`) and\nno AI variable fallback. Kenso then holds each contact's LinkedIn sequence at this step instead of sending the\ntoken as written. The AI variable fallbacks are read under the campaign's own AI prompts and under each segment's\nthe step can run under; a token only a segment's prompts leave unfilled reads\n`unfilled_token:<name> (segment \"<segment name>\")`. Null when there is nothing to report.","nullable":true}},"additionalProperties":false,"description":"One variant of one LinkedIn step in a sequence, timed around the emails."},"LinkedInSequenceVersionDetail":{"type":"object","properties":{"id":{"type":"integer","description":"The version's id.","format":"int64"},"versionNumber":{"type":"integer","description":"The version's number within its sequence. The first version is 1, and each new version gets the next number.","format":"int32"},"createdAt":{"type":"string","description":"When Kenso saved the version, in UTC.","format":"date-time"},"createdByUserId":{"type":"integer","description":"The id of the member who saved the version. Omitted when Kenso could not match the saver to a member.","format":"int64","nullable":true},"createdByEmail":{"type":"string","description":"The email address of the member who saved the version. Omitted when none was recorded.","nullable":true},"isRevert":{"type":"boolean","description":"True when the version records a restore of an earlier version."},"revertedFromVersionId":{"type":"integer","description":"The id of the version that was restored. Omitted when `isRevert` is false.","format":"int64","nullable":true},"revertedFromVersionNumber":{"type":"integer","description":"The number of the version that was restored. Omitted when `isRevert` is false.","format":"int32","nullable":true},"revertedFromCreatedAt":{"type":"string","description":"When the restored version was saved, in UTC. Omitted when `isRevert` is false.","format":"date-time","nullable":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/LinkedInSequenceSnapshotStep"},"description":"Every step and variant of the LinkedIn sequence when the version was saved, inactive ones included."}},"additionalProperties":false,"description":"A saved version of a LinkedIn sequence, with its steps as they were saved.","example":{"id":3310,"versionNumber":2,"createdAt":"2026-10-14T09:41:27Z","createdByUserId":1093,"createdByEmail":"jordan.patel@northwind-outbound.example.com","isRevert":false,"steps":[{"stepOrder":1,"stepType":"connection_request","variant":"a","body":"Hi {firstName}, I work with engineering leaders on onboarding. Glad to connect.","waitDays":1,"anchorEmailStepOrder":1,"positionInGap":0,"conditionType":"none","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"noteMode":"template"},{"stepOrder":2,"stepType":"message","variant":"a","body":"Thanks for connecting, {firstName}. Did my email about onboarding new engineers reach you?","waitDays":2,"anchorEmailStepOrder":1,"positionInGap":1,"conditionType":"accepted","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true}]}},"LinkedInSequenceVersionDetailResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/LinkedInSequenceVersionDetail"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"LinkedInSequenceVersionSave":{"type":"object","properties":{"sequence":{"allOf":[{"$ref":"#/components/schemas/LinkedInSequence"}],"description":"The LinkedIn sequence as the saved version holds it, in the same shape as\n`GET /v1/campaigns/{campaignId}/linkedin-sequence`. The live sequence does not change."},"version":{"allOf":[{"$ref":"#/components/schemas/SequenceVersion"}],"description":"The version Kenso saved."},"versionWarning":{"type":"string","description":"Why Kenso could not record the version. Omitted when it did.","nullable":true}},"additionalProperties":false,"description":"The result of saving a LinkedIn sequence version.","example":{"sequence":{"campaignId":4821,"steps":[{"stepOrder":1,"stepType":"connection_request","variant":"a","body":"Hi {firstName}, I work with engineering leaders on onboarding. Glad to connect.","waitDays":1,"anchorEmailStepOrder":1,"positionInGap":0,"conditionType":"none","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"noteMode":"template","id":9301,"requiresApproval":false,"warnings":[]},{"stepOrder":2,"stepType":"message","variant":"a","body":"Thanks for connecting, {firstName}. Did my email about onboarding new engineers reach you?","waitDays":2,"anchorEmailStepOrder":1,"positionInGap":1,"conditionType":"accepted","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"id":9302,"requiresApproval":false,"warnings":[]}],"connectionNoteMaxChars":200},"version":{"id":3310,"versionNumber":2,"createdAt":"2026-10-14T09:41:27Z","createdByUserId":1093,"createdByEmail":"jordan.patel@northwind-outbound.example.com","isRevert":false}}},"LinkedInSequenceVersionSaveResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/LinkedInSequenceVersionSave"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"Pagination":{"type":"object","properties":{"nextCursor":{"type":"string","description":"Send this value as `cursor` to get the next page. Omitted on the last page.","nullable":true},"hasMore":{"type":"boolean","description":"True when more items follow this page. Stop paging when it is false."},"total":{"type":"integer","description":"Deprecated: the same number as `totalCount`. Read `totalCount`.","format":"int32","nullable":true,"deprecated":true},"totalCount":{"type":"integer","description":"The number of items that match the list's filters, across all pages. Omitted when the list does not count them.","format":"int32","nullable":true},"isTotalCapped":{"type":"boolean","description":"True when `totalCount` stopped counting at its cap, so more items match than it says. Keep paging with\n`hasMore`. Omitted when `totalCount` is exact. Only `GET /v1/threads` with `q` caps its total.","nullable":true}},"additionalProperties":false,"description":"Where a list page ends and how to get the next page."},"RateLimitedText":{"type":"string","description":"The gateway's plain-text body of a `429` over the operation's own limit, until November 2026: `Number of requests exceeded. Please try again later.`","example":"Number of requests exceeded. Please try again later."},"Refusal":{"type":"object","properties":{"code":{"type":"string","description":"Stable refusal code in upper case, such as `CAMPAIGN_LIMIT_REACHED` or `INSUFFICIENT_CREDITS`."},"metric":{"type":"string","description":"What the limit counts: `Campaigns`, `Leads`, `Emails`, `LinkedInSeats` or `AiCredits`,\n`jobs_export_rows` or `funding_export_rows` for an export allowance, `credit_pack_credits`,\n`credit_spend_usd_7d`, `domains` or `mailboxes` for a limit on a new paying workspace, or for a\nKenso Lifetime cap its key: `workspaces`, `inboxes`, `contacts`, `email_verifications_day`,\n`email_verifications_month`, `people_results_day`, `company_results_day`,\n`funding_results_day`, `job_post_results_day`, `website_visits_month` or\n`visitor_lookups_day`. Omitted when a plan rule, not a count, refused the request.","nullable":true},"used":{"type":"integer","description":"How much of the limit is used, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"limit":{"type":"integer","description":"The limit, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"remaining":{"type":"integer","description":"How much of the limit is left, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"planType":{"type":"string","description":"The workspace's plan as its snake plan id, for example `free`, `legacy_core` or `growth`."},"remedy":{"type":"string","description":"What lifts the refusal: `Upgrade`, `BuyAddOn`, `UpdatePaymentMethod` or `ContactSupport`.\n`None` means no action of yours lifts it."},"unlocksAt":{"type":"string","description":"When the limit lifts by itself, in UTC: for a limit on a new paying workspace once it has paid an invoice, and for\na Kenso Lifetime daily or monthly cap its reset (00:00 UTC, or the 1st of the month). Omitted on every other\nrefusal.","format":"date-time","nullable":true},"requiredMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits the action needed. 1,000 millicredits are one credit. Omitted on every\nother refusal.","format":"int64","nullable":true},"availableMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits available. On `FREE_CREDITS_NOT_ELIGIBLE`, only the credits that may\npay for inboxes and domains. Omitted on every other refusal.","format":"int64","nullable":true},"restrictedMillicredits":{"type":"integer","description":"On `FREE_CREDITS_NOT_ELIGIBLE`, the free and bonus millicredits in the balance that cannot pay for inboxes\nand domains. Omitted on every other refusal.","format":"int64","nullable":true},"feature":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the plan feature the plan does not include, in snake case (for example\n`website_visitor_id`). Omitted on every other refusal.","nullable":true},"requiredPlan":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the cheapest plan that includes `feature`, in snake case (for example\n`growth`). For a feature the self-serve trial locks (`browser_runs`), the trial's own plan,\nwhich paying for unlocks it. Omitted on every other refusal.","nullable":true},"requiredTier":{"type":"integer","description":"On a Kenso Lifetime refusal, the lowest tier that lifts it: the next tier with a higher cap, or the lowest tier\nthat includes `feature`. Omitted at the top tier, when no tier includes the feature, and on every other\nrefusal.","format":"int32","nullable":true},"upgradeUrl":{"type":"string","description":"On a Kenso Lifetime refusal that a higher tier lifts, the AppSumo page where the buyer upgrades their license.\nOmitted until Kenso has read that page from AppSumo, when no tier lifts the refusal, and on every other refusal.","nullable":true}},"additionalProperties":false,"description":"Why a plan rule or usage limit refused the request, and how to lift it."},"ReplaceLinkedInSequenceRequest":{"required":["steps"],"type":"object","properties":{"steps":{"type":"array","items":{"$ref":"#/components/schemas/ReplaceLinkedInSequenceStepRequest"},"description":"Every step and variant the sequence should have. Required. A row with an `id` updates that row, a row without\none updates the row with the same `stepOrder`, `variant` and `stepType` or is added, and rows you leave out\nare deleted. An empty list deletes every LinkedIn step."},"instruction":{"type":"string","description":"The person's request that led to this change, in their own words when you have them. Optional. Kenso keeps it\nwith the edit history of the steps this save changes, marked as reported by your agent, and keeps the first\n2,000 characters. Leave it out when no person asked for the change; never invent one.","nullable":true}},"additionalProperties":false,"description":"The whole LinkedIn sequence to save. The steps you send replace every LinkedIn step of the sequence.","example":{"steps":[{"stepOrder":1,"stepType":"connection_request","variant":"a","body":"Hi {firstName}, I work with engineering leaders on onboarding. Glad to connect.","waitDays":1,"anchorEmailStepOrder":1,"positionInGap":0,"conditionType":"none","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"noteMode":"template","id":9301},{"stepOrder":2,"stepType":"message","variant":"a","body":"Thanks for connecting, {firstName}. Did my email about onboarding new engineers reach you?","waitDays":2,"anchorEmailStepOrder":1,"positionInGap":1,"conditionType":"accepted","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"id":9302}],"instruction":"Message on LinkedIn once the invitation is accepted."}},"ReplaceLinkedInSequenceStepRequest":{"required":["stepType"],"type":"object","properties":{"id":{"type":"integer","description":"The id of the row to update. Omit it to update the row with the same `stepOrder`, `variant` and `stepType`, or\nto add a new one.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"The step's position in the LinkedIn sequence, starting at 1. The variants of one step share it.","format":"int32"},"stepType":{"type":"string","description":"What the step does: `profile_visit`, `connection_request`, `message`, `voice_note`, `follow`, `like_post`,\n`endorse_skill` or `comment_post`. Required. `in_mail` is refused: use `message`, which Kenso can send as an\nInMail to a contact who is not connected. `follow`, `like_post`, `endorse_skill` and `comment_post` need the\n`linkedin_engagement` feature, and `voice_note` needs the `linkedin_voice_notes` feature."},"variant":{"type":"string","description":"The variant for A/B testing: `a`, `b`, `c` or `d`, in any letter case. Defaults to `a`. Every step needs\nvariant `a`, and `profile_visit`, `follow`, `like_post`, `endorse_skill` and `comment_post` steps cannot have\nother variants.","nullable":true},"name":{"type":"string","description":"A label for the variant, at most 255 characters. LinkedIn never shows it.","nullable":true},"subject":{"type":"string","description":"The InMail subject of a `message` or `voice_note` step, at most 200 characters. Kenso uses it when the step\ngoes out as an InMail.","nullable":true},"body":{"type":"string","description":"The text of the step. A `connection_request` note is at most 275 characters, and must be empty when `noteMode`\nis `ai`. A `message` needs a body of at most 1,900 characters. A `voice_note` needs the text Kenso sends when\nthe voice note cannot go, at most 1,900 characters. A `comment_post` body is optional guidance for the comment\nKen writes, at most 500 characters. Other step types ignore it.","nullable":true},"waitDays":{"type":"integer","description":"Days Kenso waits before the step, at least 0. They count from when the anchor email is sent, or from when the\ncontact entered the LinkedIn sequence when `anchorEmailStepOrder` is 0.","format":"int32"},"anchorEmailStepOrder":{"type":"integer","description":"The `stepOrder` of the email step this step follows, or 0 to place it before the first email. When the email\nsequence has steps, it must be one of them.","format":"int32"},"positionInGap":{"type":"integer","description":"The step's order among the LinkedIn steps that follow the same email, at least 0. Lower numbers run first.","format":"int32"},"conditionType":{"type":"string","description":"What must happen before the step runs: `none` (the default), `clicked` (the contact clicked a link in an\nemail), `replied_positive` (the contact replied with interest), `accepted` (the contact accepted the invitation\nor is already connected), `engaged` (the contact read or reacted to a LinkedIn message) or `not_accepted` (the\ncontact did not accept the invitation within the campaign's `notAcceptedAfterDays`). `accepted` and\n`not_accepted` need a `connection_request` earlier in the sequence, and `engaged` needs a `message` or\n`voice_note` earlier. When the condition is not met within its waiting window, Kenso skips the step.","nullable":true},"conditionScopeStepOrder":{"type":"integer","description":"For a `clicked` condition, the `stepOrder` of the email whose link must be clicked. Null or omitted means a\nlink in any email sent so far.","format":"int32","nullable":true},"isOptional":{"type":"boolean","description":"Set to true to skip the step once the next email after its anchor email is sent. Defaults to false."},"openProfileOnly":{"type":"boolean","description":"Set to true so that, when a `message` step goes out as a free InMail, Kenso sends it only to open profiles and\nskips the others. Defaults to false."},"waitFromCondition":{"type":"boolean","description":"With an `accepted` or `not_accepted` condition, set to true to also count `waitDays` from the moment the\ncondition came true (the contact accepted, or the invite expired). The step goes once both waits have passed: the\none after the anchor and the one after the condition. A `message` with `accepted`, `waitDays` 1 and this on goes\none day after the contact connects, and never before its anchor wait. Any other condition rejects it. Defaults to\nfalse."},"isActive":{"type":"boolean","description":"Whether Kenso runs this variant. Defaults to true."},"noteMode":{"type":"string","description":"How a `connection_request` gets its note: `template` sends `body`, and `ai` has Ken write a note for each\ncontact. `ai` needs the `linkedin_ai_notes` feature and an empty `body`, and only `connection_request` steps\ncan use it. Omit it to keep the stored mode, or `template` for a new row.","nullable":true},"aiInstructions":{"type":"string","description":"Your instructions to Ken for writing the notes of a `connection_request` with `noteMode` `ai`, at most 1,000\ncharacters. Only `connection_request` steps can have them.","nullable":true},"voice":{"allOf":[{"$ref":"#/components/schemas/VoiceNoteSettingsRequest"}],"description":"The voice settings of a `voice_note` step. Required on a `voice_note` step, and refused on every other step\ntype."},"requiresApproval":{"type":"boolean","description":"For a `like_post`, `endorse_skill` or `comment_post` step: true holds each like, endorsement or comment in\nApprovals until a person approves it, with the exact comment or the post or skill as the preview. False lets Ken\nact without asking. Omit it to keep the stored value; a new step of these types starts at true. Ignored, and\nstored false, on every other step type.","nullable":true}},"additionalProperties":false,"description":"One variant of one LinkedIn step to save. The step's type and timing come from variant `a`: `stepType`,\n`waitDays`, `anchorEmailStepOrder`, `positionInGap`, `conditionType`, `conditionScopeStepOrder`, `isOptional` and\n`openProfileOnly`. Each variant sets its own `body`, `subject`, `name`, `isActive`, `noteMode` and\n`aiInstructions`."},"SaveLinkedInVersionRequest":{"type":"object","properties":{"sourceVersionId":{"type":"integer","description":"The id of a saved version of this LinkedIn sequence to start from. Omit it to save a copy of the live steps.","format":"int64","nullable":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ReplaceLinkedInSequenceStepRequest"},"description":"The steps to store in the version, in the same shape as a LinkedIn sequence replace. Used only with\n`sourceVersionId`, where a non-empty list replaces that version's steps. Kenso checks the steps with the\nLinkedIn sequence rules either way.","nullable":true}},"additionalProperties":false,"description":"What to put in a saved LinkedIn sequence version.","example":{"sourceVersionId":3306,"steps":[{"stepOrder":1,"stepType":"connection_request","variant":"a","body":"Hi {firstName}, I work with engineering leaders on onboarding. Glad to connect.","waitDays":1,"anchorEmailStepOrder":1,"positionInGap":0,"conditionType":"none","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"noteMode":"template","id":9301},{"stepOrder":2,"stepType":"message","variant":"a","body":"Thanks for connecting, {firstName}. Did my email about onboarding new engineers reach you?","waitDays":2,"anchorEmailStepOrder":1,"positionInGap":1,"conditionType":"accepted","isOptional":false,"openProfileOnly":false,"waitFromCondition":false,"isActive":true,"id":9302}]}},"SequenceRestore":{"type":"object","properties":{"newVersionNumber":{"type":"integer","description":"The number of the new version that records the restore. Omitted when Kenso restored the steps but could not\nrecord the version.","format":"int32","nullable":true},"versionWarning":{"type":"string","description":"Why Kenso could not record the version after it restored the steps. Omitted when it did.","nullable":true}},"additionalProperties":false,"description":"The result of restoring a sequence version.","example":{"newVersionNumber":7}},"SequenceRestoreResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SequenceRestore"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SequenceVersion":{"type":"object","properties":{"id":{"type":"integer","description":"The version's id.","format":"int64"},"versionNumber":{"type":"integer","description":"The version's number within its sequence. The first version is 1, and each new version gets the next number.","format":"int32"},"createdAt":{"type":"string","description":"When Kenso saved the version, in UTC.","format":"date-time"},"createdByUserId":{"type":"integer","description":"The id of the member who saved the version. Omitted when Kenso could not match the saver to a member.","format":"int64","nullable":true},"createdByEmail":{"type":"string","description":"The email address of the member who saved the version. Omitted when none was recorded.","nullable":true},"isRevert":{"type":"boolean","description":"True when the version records a restore of an earlier version."},"revertedFromVersionId":{"type":"integer","description":"The id of the version that was restored. Omitted when `isRevert` is false.","format":"int64","nullable":true},"revertedFromVersionNumber":{"type":"integer","description":"The number of the version that was restored. Omitted when `isRevert` is false.","format":"int32","nullable":true},"revertedFromCreatedAt":{"type":"string","description":"When the restored version was saved, in UTC. Omitted when `isRevert` is false.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"A saved version of an email or LinkedIn sequence.","example":{"id":3302,"versionNumber":6,"createdAt":"2026-10-14T09:41:27Z","createdByUserId":1093,"createdByEmail":"jordan.patel@northwind-outbound.example.com","isRevert":false}},"SequenceVersionListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/SequenceVersion"},"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."},"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."},"VoiceNoteSettings":{"type":"object","properties":{"provider":{"type":"string","description":"The voice provider: `deepgram` or `elevenlabs`."},"voiceId":{"type":"string","description":"The voice's id, as `GET /v1/voices` lists it."},"speed":{"type":"number","description":"How fast the voice speaks, from 0.50 to 1.50. Only `deepgram` voices use it. Null means the voice's normal\nspeed.","format":"double","nullable":true},"wordsMode":{"type":"string","description":"Who writes the words: `ken_writes` (Ken writes each note from `instructions`) or `script` (the voice reads\n`script`)."},"instructions":{"type":"string","description":"What Ken should say, when `wordsMode` is `ken_writes`. Null otherwise.","nullable":true},"script":{"type":"string","description":"The words the voice reads, when `wordsMode` is `script`. Null otherwise.","nullable":true},"model":{"type":"string","description":"The model Ken writes with when `wordsMode` is `ken_writes`: `haiku` or `sonnet`. Null means `haiku`.","nullable":true},"matchLeadLanguage":{"type":"boolean","description":"Whether the note is spoken in each contact's outreach language instead of the voice's own. For a `deepgram`\nvoice, Kenso picks a voice of the same gender in that language, and keeps the chosen voice and its language\nwhen there is none."}},"additionalProperties":false,"description":"How Kenso records the voice note of a `voice_note` step for each contact."},"VoiceNoteSettingsRequest":{"required":["provider","voiceId","wordsMode"],"type":"object","properties":{"provider":{"type":"string","description":"The voice provider: `deepgram` or `elevenlabs`. Required."},"voiceId":{"type":"string","description":"The voice's id, as `GET /v1/voices` lists it, at most 200 characters. Required."},"speed":{"type":"number","description":"How fast the voice speaks, from 0.50 to 1.50. Only `deepgram` voices use it. Null or omitted means the voice's\nnormal speed.","format":"double","nullable":true},"wordsMode":{"type":"string","description":"Who writes the words: `ken_writes` (Ken writes each note from `instructions`) or `script` (the voice reads\n`script`). Required."},"instructions":{"type":"string","description":"What Ken should say, at most 1,000 characters. Required when `wordsMode` is `ken_writes`, and must be empty\nwhen it is `script`.","nullable":true},"script":{"type":"string","description":"The words the voice reads, at most 900 characters. Required when `wordsMode` is `script`, and must be empty\nwhen it is `ken_writes`.","nullable":true},"model":{"type":"string","description":"The model Ken writes with when `wordsMode` is `ken_writes`: `haiku` or `sonnet`. Null or omitted means `haiku`.","nullable":true},"matchLeadLanguage":{"type":"boolean","description":"Set to true to speak each note in the contact's outreach language instead of the voice's own. For a `deepgram`\nvoice, Kenso picks a voice of the same gender in that language, and keeps the chosen voice when there is none.\nDefaults to false."}},"additionalProperties":false,"description":"How Kenso records the voice note of a `voice_note` step for each contact."}}}}