{"openapi":"3.0.4","info":{"title":"Kenso API: Triggers","version":"1.1","description":"The Triggers 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":"triggers","description":"A trigger adds a contact to a campaign when a signal happens, such as a reply, a link click, a job change or a\ncompany raising money. Each trigger watches one signal type for one campaign, and its parameters set the\nthreshold, for example how many clicks in how many minutes. Every time a trigger acts on a contact, Kenso records a\nfiring that you can list with its outcome. `GET /v1/trigger-schemas` lists each signal type's parameters and\ndefaults.","x-displayName":"Triggers"}],"paths":{"/v1/triggers":{"get":{"tags":["triggers"],"summary":"List triggers","description":"Returns the workspace's triggers. Filter them by `campaignId` and by `status`.\n            \nErrors:\n            \n- `400 validation_failed`: `status`, `limit` or `cursor` is invalid.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"triggers.list","parameters":[{"name":"limit","in":"query","description":"How many triggers to return, from 1 to 200. Default 50.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"cursor","in":"query","description":"The `pagination.nextCursor` of the previous page.","schema":{"type":"string"}},{"name":"campaignId","in":"query","description":"Only the triggers that add contacts to this campaign.","schema":{"type":"integer","format":"int64"}},{"name":"status","in":"query","description":"Only triggers with this status: `active`, `paused` or `archived`.","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/TriggerListResponse"}}}},"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":["triggers"],"summary":"Create a trigger","description":"Creates a trigger that watches one signal type for a campaign. The trigger starts as `active`.\n            \n`campaignId` and `signalType` are required. The campaign must be in trigger mode. To use a batch\ncampaign, send `switchCampaignToTrigger: true`, and Kenso switches the campaign to trigger mode in the same\nstep, so a failed create leaves the campaign as it was. The LinkedIn signal types,\n`linkedin_post_engagement` and `linkedin_profile_view`, take a campaign that is not in trigger mode\nand need the `linkedin_signals` feature. A `linkedin_post_engagement` trigger on pasted posts takes\nposts no older than 30 days, and a workspace has at most 10 such posts active.\n            \n`parameters` is a JSON string with the keys `GET /v1/trigger-schemas` lists for the signal type.\nOmitted fields take these defaults: `cooldownMinutes` 10080 (7 days), `maxAgeMinutes` 1440 (1 day),\n`priority` 50 and `stopSourceSequence` true. `cooldownMinutes` is at least 1, and\n`maxAgeMinutes` is from 1 to 10080. `tier` is deprecated and has no effect: every trigger is processed\nat the same speed.\n            \nA campaign has at most one active `lead_uploaded` trigger and one active `webhook_lead_received`\ntrigger. Both types need email enrichment and email verification set up on the campaign, and Kenso creates a\nstaging campaign for them, returned as `stagingCampaignId`.\n            \nErrors:\n            \n- `400 validation_failed`: a field is missing or invalid, the parameters or audience filter do not fit\nthe signal type, the campaign has the wrong mode, or a `lead_uploaded` or `webhook_lead_received`\ntrigger already exists or lacks email enrichment and verification.\n- `402 plan_required`: the workspace's plan does not include the feature the signal type reads:\n`funding_signals` for `fundraising`, `job_post_search` for `open_roles`. `error.refusal`\ncarries the code `PLAN_FEATURE_NOT_AVAILABLE` and the feature.\n- `404 not_found`: the campaign is not in the workspace.\n- `409 conflict`: an active trigger of this type already exists for this campaign.\n            \nRequires Campaigns edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"triggers.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/CreateTriggerRequest"}}}},"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/TriggerResponse"}}}},"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_required"]},"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/triggers/{triggerId}":{"get":{"tags":["triggers"],"summary":"Get a trigger","description":"Returns one trigger with its signal type, parameters and status.\n            \nErrors:\n            \n- `404 not_found`: the workspace has no trigger with this id.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"triggers.get","parameters":[{"name":"triggerId","in":"path","description":"The trigger'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/TriggerResponse"}}}},"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":["triggers"],"summary":"Update a trigger","description":"Changes the fields you send. Omitted fields keep their values.\n            \nThe body can hold `status` (`active` or `paused`), `parameters` (a JSON string),\n`audienceFilter` (a JSON string, or null to clear the filter), `cooldownMinutes`,\n`maxAgeMinutes`, `priority` and `stopSourceSequence`. Their rules are the same as on create.\n`tier` (`minutes`, `hours` or `same_day`) is still accepted but deprecated: it has no\neffect. `signalType` and `campaignId` cannot change. To archive a trigger, use\n`DELETE /v1/triggers/{triggerId}`.\n            \nErrors:\n            \n- `400 validation_failed`: a field has the wrong type or value, the body changes `signalType` or\n`campaignId`, `status` is `archived`, or the trigger is archived.\n- `402 plan_required`: the body sends `parameters`, or sets `status` to `active` on a trigger\nthat is not active, and the workspace's plan does not include the feature the signal type reads (as on create).\nPausing and other edits are not refused.\n- `404 not_found`: the workspace has no trigger with this id.\n- `409 conflict`: an active trigger of this type already exists for the campaign.\n            \nRequires Campaigns edit.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"triggers.update","parameters":[{"name":"triggerId","in":"path","description":"The trigger'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":{"description":"The fields to change.","content":{"application/json":{"schema":{}}}},"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/TriggerResponse"}}}},"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_required"]},"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":12000,"windowSeconds":60,"per":"api_key"}},"delete":{"tags":["triggers"],"summary":"Archive a trigger","description":"Archives the trigger, so it stops firing. An archived trigger cannot be changed or made active again, and it\nstays readable.\n            \nErrors:\n            \n- `404 not_found`: the workspace has no trigger with this id.\n- `409 conflict`: another request changed the trigger at the same time. Read it again and retry.\n            \nRequires Campaigns edit.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"triggers.delete","parameters":[{"name":"triggerId","in":"path","description":"The trigger'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":{"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"]},"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":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/triggers/preview":{"post":{"tags":["triggers"],"summary":"Preview a trigger's matching companies","description":"Runs a trigger's parameters against live company data and shows which companies would match, how many pass\neach step, and an estimated credit cost. Kenso saves nothing, fires nothing and charges nothing, and the\npreview does not use your export allowance. Use it to tune parameters before you create the trigger.\n            \n`signalType` is `fundraising`, `open_roles` or `company_headcount_growth`.\n`parameters` is a JSON object with the same keys a trigger stores. `limit` is from 1 to 25 companies,\ndefault 25. To read the next page, pass `pagination.nextCursor` as `cursor`.\n            \nEvery page has:\n            \n- `companies`: sample matching companies.\n- `total`: the matching companies across all pages, or null for `open_roles`.\n- `steps`: the name, count and description of each filter step on this page, in order. The last step,\n`max_contacts_per_company`, is the most people the page can import.\n- `estimatedCredits`: `isEstimate` (always true), `leads`, `credits`,\n`totalMillicredits`, `lines` and `basis`. `basis` says how Kenso computed it: those people\nat the leads rate of `POST /v1/credits/estimates`.\n            \nErrors:\n            \n- `400 validation_failed`: `signalType` or `parameters` is invalid. For a signal type the\npreview does not cover, `error.details[0].code` is `preview_not_supported`.\n            \nRequires Campaigns edit.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"triggers.preview","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/PreviewTriggerRequest"}}}},"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/TriggerPreviewPageResponse"}}}},"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":240,"windowSeconds":60,"per":"api_key"}}},"/v1/triggers/{triggerId}/test-fire":{"post":{"tags":["triggers"],"summary":"Test a trigger with a sample signal","description":"Checks one sample signal of the trigger's own type the way Kenso checks a real one, and says whether the trigger\nwould fire and why. Kenso queues no signal, starts no cooldown, records no firing, changes no counter, and sends\nor charges nothing. It does not replay recent signals: the sample is the only input.\n            \n`contactId` is required. `campaignId` feeds the audience filter. `payload` is the signal's JSON\nobject, for example `clickedUrl` for `link_clicked` or `classification` for\n`reply_received`. `occurredAt` defaults to now.\n            \nKenso runs every check in order: `status`, `audience_filter`, `parameters` and\n`cooldown`. `rejectedBy` names the first that failed. `status` fails for a paused or archived\ntrigger and for one whose campaign was deleted. A real firing can still be suppressed later, for example by do\nnot contact, the blocklist or a frequency cap.\n            \nErrors:\n            \n- `400 validation_failed`: `contactId` is missing, the contact or campaign is not in the workspace,\nor the body is invalid. For a signal type that only a scheduled scan produces, `error.details[0].code` is\n`test_fire_not_supported`.\n- `404 not_found`: the workspace has no trigger with this id.\n            \nRequires Campaigns edit.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"triggers.test-fire","parameters":[{"name":"triggerId","in":"path","description":"The trigger to test.","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/TestFireTriggerRequest"}}}},"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/TriggerTestFireResponse"}}}},"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":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/triggers/{triggerId}/stats":{"get":{"tags":["triggers"],"summary":"Get a trigger's firing stats","description":"Returns how many times the trigger fired over the last `days` days, how many of those firings added the\ncontact to the campaign, and how many Kenso suppressed, by reason.\n            \n`days` is from 1 to 90, default 7.\n            \nErrors:\n            \n- `400 validation_failed`: `days` is out of range.\n- `404 not_found`: the workspace has no trigger with this id.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"triggers.get-stats","parameters":[{"name":"triggerId","in":"path","description":"The trigger's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"days","in":"query","description":"How many days back to count, from 1 to 90. Default 7.","schema":{"type":"integer","format":"int32"}},{"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/TriggerStatsResponse"}}}},"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/triggers/{triggerId}/linkedin-engagements":{"get":{"tags":["triggers"],"summary":"List a trigger's LinkedIn engagements","description":"Returns the reactions, comments, replies and profile views a LinkedIn signal trigger found, newest first.\n            \nEach item names the person who engaged (`actor`), the post and comment when there is one, and for an\n`imported` item the person's contact in the campaign. `skipReason` says why Kenso skipped an item.\nItems also carry the reaction type, the comment and parent comment ids, the post text, the AI-assigned intent\nof a comment with its reason, and `ownPost`. A trigger of another signal type returns an empty list.\n            \nErrors:\n            \n- `400 validation_failed`: `status`, `limit` or `cursor` is invalid.\n- `404 not_found`: the workspace has no trigger with this id.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `linkedin_signals` feature on your workspace. Until it is on, calls answer 404.","operationId":"triggers.list-linkedin-engagements","parameters":[{"name":"triggerId","in":"path","description":"The trigger's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"How many engagements to return, from 1 to 200. Default 50.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"cursor","in":"query","description":"The `pagination.nextCursor` of the previous page.","schema":{"type":"string"}},{"name":"status","in":"query","description":"Only engagements with this status: `new`, `imported`, `offered` or `skipped`.","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/LinkedInEngagementListResponse"}}}},"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-features":["linkedin_signals"],"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."},"CreateTriggerRequest":{"required":["campaignId","signalType"],"type":"object","properties":{"campaignId":{"type":"integer","description":"Required. The campaign the trigger adds contacts to.","format":"int64"},"signalType":{"type":"string","description":"Required. The signal type to watch, such as `link_clicked`, `reply_received` or `job_change`."},"tier":{"type":"string","description":"Deprecated: no effect, so leave it out. Every trigger is processed at the same speed whatever its tier.\nStill accepted: `minutes`, `hours` or `same_day`. Default `minutes`.","nullable":true},"parameters":{"type":"string","description":"The signal type's parameters as a JSON string, with the keys `GET /v1/trigger-schemas` lists. Omitted:\n`{}`, which a signal type with required parameters refuses.","nullable":true},"audienceFilter":{"type":"string","description":"The campaigns whose contacts to watch, as a JSON string `{\"sourceCampaignIds\":[1,2]}`. The list cannot be\nempty, and every campaign must be in the workspace. Omitted: every campaign in the workspace. A\n`job_change` trigger requires it.","nullable":true},"cooldownMinutes":{"type":"integer","description":"Minutes before the trigger can fire again for the same contact, at least 1. Default 10080 (7 days).","format":"int32","nullable":true},"maxAgeMinutes":{"type":"integer","description":"Minutes a firing may wait to be processed before Kenso drops it, from 1 to 10080. Default 1440 (1 day).","format":"int32","nullable":true},"priority":{"type":"integer","description":"When several triggers fire for the same person at once, the highest priority wins. Default 50.","format":"int32","nullable":true},"stopSourceSequence":{"type":"boolean","description":"True stops the contact's sequence in its current campaign when the trigger adds it. Default true.","nullable":true},"switchCampaignToTrigger":{"type":"boolean","description":"True switches a batch campaign to trigger mode as part of the create, so a failed create leaves the campaign as\nit was. Default false. Ignored for the LinkedIn signal types.","nullable":true}},"additionalProperties":false,"description":"The trigger to create."},"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."},"LinkedInEngagement":{"type":"object","properties":{"id":{"type":"integer","description":"The engagement's id.","format":"int64"},"kind":{"type":"string","description":"The kind of engagement: `post_reaction`, `post_comment`, `post_reply`, `profile_view`, or\n`post_author` for the person who wrote a post a topic found."},"postUrl":{"type":"string","description":"The LinkedIn post the person engaged with. Null for a profile view.","nullable":true},"actor":{"allOf":[{"$ref":"#/components/schemas/LinkedInEngagementActor"}],"description":"The person who engaged."},"commentText":{"type":"string","description":"The text of the comment or reply. Null for reactions and profile views.","nullable":true},"reactionType":{"type":"string","description":"For a reaction: `like`, `celebrate`, `support`, `love`, `insightful` or\n`funny`. Null otherwise.","nullable":true},"commentId":{"type":"string","description":"LinkedIn's id of the comment or reply.","nullable":true},"parentCommentId":{"type":"string","description":"For a `post_reply`, the id of the comment it answers. Null otherwise.","nullable":true},"postText":{"type":"string","description":"The text of the post, cut at 2,000 characters.","nullable":true},"intent":{"type":"string","description":"The AI-assigned intent of a comment or reply: `positive`, `requesting`, `question`,\n`neutral` or `negative`. Null for reactions and until the comment is classified.","nullable":true},"intentReason":{"type":"string","description":"A one-line reason for the intent.","nullable":true},"ownPost":{"type":"boolean","description":"True when the post belongs to one of the workspace's LinkedIn accounts or company pages. False for a pasted\npost by someone else, and for every post a topic or a watched profile found."},"sourceKind":{"type":"string","description":"Where the engagement was found: `seat` (a LinkedIn account's own post), `page` (a company page),\n`post` (a pasted post), `topic` (a post a topic keyword found) or `person` (a post of a watched\nprofile or company page). Left out for a profile view and for engagements stored before this field existed.","nullable":true},"topic":{"type":"string","description":"For a `topic` source, the keyword as the trigger lists it. For a `person` source, the watched person's\nor page's name, or its URL until LinkedIn has named it. Left out for the other sources.","nullable":true},"occurredAt":{"type":"string","description":"When the person engaged, in UTC, when LinkedIn says. Null otherwise.","format":"date-time","nullable":true},"firstSeenAt":{"type":"string","description":"When Kenso first found the engagement, in UTC.","format":"date-time"},"status":{"type":"string","description":"The engagement's status: `new`, `imported` (Kenso added the person as a contact), `offered` (a workflow run took it, with\nno contact) or `skipped`."},"skipReason":{"type":"string","description":"Why Kenso skipped it: `own_seat`, `kind_filtered`, `reaction_type_filtered`,\n`keyword_mismatch`, `intent_filtered`, `headline_filtered` (the person's headline missed the\ntrigger's headline keywords), or `not_imported` when no contact was created. Null unless `status` is\n`skipped`.","nullable":true},"contactId":{"type":"integer","description":"For an `imported` engagement, the person's contact in the campaign. Null otherwise.","format":"int64","nullable":true}},"additionalProperties":false,"description":"One reaction, comment, reply, post author or profile view a LinkedIn signal trigger found."},"LinkedInEngagementActor":{"type":"object","properties":{"name":{"type":"string","description":"The person's name on LinkedIn.","nullable":true},"headline":{"type":"string","description":"The person's LinkedIn headline.","nullable":true},"profileUrl":{"type":"string","description":"The person's LinkedIn profile URL."}},"additionalProperties":false,"description":"The person who engaged on LinkedIn."},"LinkedInEngagementListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/LinkedInEngagement"},"description":"The items on this page."},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Where this page ends and how to get the next one."}},"additionalProperties":false,"description":"The body of a successful list operation: one page of results in `data`, and `pagination` to get the next\npage."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"Pagination":{"type":"object","properties":{"nextCursor":{"type":"string","description":"Send this value as `cursor` to get the next page. Omitted on the last page.","nullable":true},"hasMore":{"type":"boolean","description":"True when more items follow this page. Stop paging when it is false."},"total":{"type":"integer","description":"Deprecated: the same number as `totalCount`. Read `totalCount`.","format":"int32","nullable":true,"deprecated":true},"totalCount":{"type":"integer","description":"The number of items that match the list's filters, across all pages. Omitted when the list does not count them.","format":"int32","nullable":true},"isTotalCapped":{"type":"boolean","description":"True when `totalCount` stopped counting at its cap, so more items match than it says. Keep paging with\n`hasMore`. Omitted when `totalCount` is exact. Only `GET /v1/threads` with `q` caps its total.","nullable":true}},"additionalProperties":false,"description":"Where a list page ends and how to get the next page."},"PreviewTriggerRequest":{"required":["signalType","parameters"],"type":"object","properties":{"signalType":{"type":"string","description":"Required. The signal type to preview: `fundraising`, `open_roles` or `company_headcount_growth`."},"parameters":{"description":"Required. The trigger's parameters as a JSON object, with the same keys a trigger stores."},"limit":{"type":"integer","description":"How many companies to return, from 1 to 25. Default 25.","format":"int32","nullable":true},"cursor":{"type":"string","description":"The `pagination.nextCursor` of the previous page.","nullable":true}},"additionalProperties":false,"description":"The trigger settings to preview."},"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."},"TestFireTriggerRequest":{"required":["contactId"],"type":"object","properties":{"contactId":{"type":"integer","description":"Required. The contact the sample signal is about. It must be in the workspace.","format":"int64"},"campaignId":{"type":"integer","description":"The campaign the sample came from, checked against the trigger's audience filter. It must be in the workspace.","format":"int64","nullable":true},"payload":{"description":"The signal's data, a JSON object of at most 16 KB, such as `{\"clickedUrl\":\"https://example.com\"}`."},"occurredAt":{"type":"string","description":"When the sample happened, in ISO 8601, within the last 365 days and not in the future. Default now.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"A sample signal to test a trigger with. Its type is the trigger's own signal type."},"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."},"Trigger":{"type":"object","properties":{"id":{"type":"integer","description":"The trigger's id.","format":"int64"},"campaignId":{"type":"integer","description":"The campaign the trigger adds contacts to.","format":"int64"},"stagingCampaignId":{"type":"integer","description":"For a `lead_uploaded` or `webhook_lead_received` trigger, the staging campaign where new leads wait for\nemail enrichment and verification before the trigger adds them. Null for the other signal types.","format":"int64","nullable":true},"signalType":{"type":"string","description":"The signal type the trigger watches, such as `link_clicked`, `reply_received` or `fundraising`."},"tier":{"type":"string","description":"Deprecated: no effect. Every trigger is processed at the same speed whatever its tier, and\n`maxAgeMinutes` bounds how long a firing may wait. Still returned and accepted: `minutes`,\n`hours` or `same_day`."},"parameters":{"type":"string","description":"The signal type's parameters as a JSON string, such as `{\"count\":3,\"windowMinutes\":10}`."},"audienceFilter":{"type":"string","description":"The campaigns whose contacts the trigger watches, as a JSON string such as `{\"sourceCampaignIds\":[1,2]}`.\nNull watches every campaign in the workspace.","nullable":true},"cooldownMinutes":{"type":"integer","description":"How long, in minutes, the trigger waits before it fires again for the same contact.","format":"int32"},"maxAgeMinutes":{"type":"integer","description":"How long, in minutes, a firing may wait to be processed. An older firing is suppressed as `expired`.","format":"int32"},"priority":{"type":"integer","description":"When several triggers fire for the same person at once, only the highest priority one acts. The others are\nsuppressed as `lost_arbitration`.","format":"int32"},"stopSourceSequence":{"type":"boolean","description":"True when Kenso stops the contact's sequence in its current campaign as the trigger adds it to this one."},"status":{"type":"string","description":"The trigger's status: `active`, `paused` or `archived`."},"createdAt":{"type":"string","description":"When the trigger was created, in UTC.","format":"date-time"},"updatedAt":{"type":"string","description":"When the trigger last changed, in UTC.","format":"date-time"},"listeningIdleReason":{"type":"string","description":"Why a `linkedin_post_engagement` trigger that lists topics or watched profiles finds nothing now.\n`no_opted_in_seat`: no LinkedIn account in the workspace has research reads turned on, and only such an\naccount reads topics and watched profiles. Returned when you get or list triggers; left out when the trigger\ncan be read, and for every other trigger.","nullable":true}},"additionalProperties":false,"description":"A trigger: one signal type it watches and the campaign it adds contacts to."},"TriggerListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"},"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."},"TriggerPreviewCompany":{"type":"object","properties":{"kenCompanyId":{"type":"integer","description":"The company's Kenso company id. Present for `open_roles` and `company_headcount_growth`.","format":"int64","nullable":true},"companyId":{"type":"integer","description":"The company's id in the funding data, the value the funding round `companyIds` filter takes. Present only for `fundraising`.","format":"int64","nullable":true},"name":{"type":"string","description":"The company's name. Null when unknown.","nullable":true},"domain":{"type":"string","description":"The company's web domain, for example `acme.com`. Null when unknown.","nullable":true},"linkedinUrl":{"type":"string","description":"The company's LinkedIn page URL. Null when unknown. Present for `open_roles` and `company_headcount_growth`.","nullable":true},"openJobCount":{"type":"integer","description":"How many open jobs the company has. Present only for `open_roles`.","format":"int32","nullable":true},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewJob"},"description":"Up to 3 of the company's matching open jobs. Present only for `open_roles`.","nullable":true},"previousHeadcount":{"type":"integer","description":"The company's employee count the month before. Null when unknown. Present only for `company_headcount_growth`.","format":"int32","nullable":true},"currentHeadcount":{"type":"integer","description":"The company's employee count this month. Null when unknown. Present only for `company_headcount_growth`.","format":"int32","nullable":true},"growthAbs":{"type":"integer","description":"How many employees the company added over the month. Null when unknown. Present only for `company_headcount_growth`.","format":"int32","nullable":true},"growthPct":{"type":"number","description":"The company's headcount growth over the month, in percent. Null when unknown. Present only for `company_headcount_growth`.","format":"float","nullable":true},"websiteUrl":{"type":"string","description":"The company's website URL. Null when unknown. Present only for `fundraising`.","nullable":true},"city":{"type":"string","description":"The city the company reported with its newest matching round. Null when unknown. Present only for `fundraising`.","nullable":true},"state":{"type":"string","description":"The two-letter US state the company reported. Null outside the US or when unknown. Present only for `fundraising`.","nullable":true},"industry":{"type":"string","description":"The company's industry as reported with its newest matching round. Null when unknown. Present only for `fundraising`.","nullable":true},"revenueRange":{"type":"string","description":"The company's revenue range as reported with its newest matching round. Null when unknown. Present only for `fundraising`.","nullable":true},"foundedYear":{"type":"integer","description":"The year the company was founded. Null when unknown. Present only for `fundraising`.","format":"int32","nullable":true},"totalRaisedUsd":{"type":"integer","description":"The company's total raised to date across all its rounds, in whole US dollars. Null when unknown. Present only for `fundraising`.","format":"int64","nullable":true},"raises":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewRaise"},"description":"Up to 10 of the company's matching round reports, newest first. Present only for `fundraising`.","nullable":true},"executives":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewExecutive"},"description":"The executive officers named on the newest matching round. Present only for `fundraising`.","nullable":true}},"additionalProperties":{},"description":"A sample company on a trigger preview page. The fields present depend on the signal type. Kenso may add fields to it."},"TriggerPreviewCreditEstimate":{"type":"object","properties":{"isEstimate":{"type":"boolean","description":"Always true: this is an estimate, not a quote."},"leads":{"type":"integer","description":"The people the page can import, the count of the `max_contacts_per_company` step.","format":"int32"},"totalMillicredits":{"type":"integer","description":"The estimated cost in millicredits (1,000 to a credit).","format":"int64"},"credits":{"type":"number","description":"The estimated cost in credits.","format":"double"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewCreditLine"},"description":"The estimate per charged action. Empty when `leads` is 0.","nullable":true},"basis":{"type":"string","description":"How Kenso computed the estimate, in words.","nullable":true}},"additionalProperties":false,"description":"An estimate of the lead credits for the people a preview page can import. Never charged."},"TriggerPreviewCreditLine":{"type":"object","properties":{"action":{"type":"string","description":"The action: `ai_qualification`, `email_found` or `ai_personalization`.","nullable":true},"units":{"type":"integer","description":"How many times the action runs.","format":"int64"},"millicredits":{"type":"integer","description":"The estimated cost of the action in millicredits.","format":"int64"},"description":{"type":"string","description":"What the action covers, in words.","nullable":true}},"additionalProperties":false,"description":"One charged action in a trigger preview's credit estimate."},"TriggerPreviewExecutive":{"type":"object","properties":{"name":{"type":"string","description":"The person's full name. Null when unknown.","nullable":true},"title":{"type":"string","description":"The person's title as reported, or `Executive officer` when none is given.","nullable":true}},"additionalProperties":{},"description":"An executive officer named on a round. Kenso may add fields to it."},"TriggerPreviewJob":{"type":"object","properties":{"title":{"type":"string","description":"The job title. Null when unknown.","nullable":true},"location":{"type":"string","description":"The job's location. Null when unknown.","nullable":true},"source":{"type":"string","description":"The job board the posting came from. Null when unknown.","nullable":true},"url":{"type":"string","description":"The URL to apply for the job. Null when unknown.","nullable":true}},"additionalProperties":false,"description":"A sample open job of a company on an `open_roles` preview."},"TriggerPreviewPage":{"type":"object","properties":{"signalType":{"type":"string","description":"The previewed signal type: `open_roles` or `company_headcount_growth`. Left out for `fundraising`.","nullable":true},"month":{"type":"string","description":"The month of the headcount data, as `yyyy-MM`. Present only for `company_headcount_growth`.","nullable":true},"companies":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewCompany"},"description":"Sample matching companies on this page.","nullable":true},"total":{"type":"integer","description":"The matching companies across all pages. Null for `open_roles`. For `fundraising` it stops at 1,000\n(see `totalIsCapped`).","format":"int64","nullable":true},"totalIsCapped":{"type":"boolean","description":"True when `total` stopped at 1,000, so more companies match. Present only for `fundraising`.","nullable":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewStep"},"description":"Each filter step on this page, in order, with how many companies or people pass it. The last step,\n`max_contacts_per_company`, is the most people the page can import.","nullable":true},"estimatedCredits":{"allOf":[{"$ref":"#/components/schemas/TriggerPreviewCreditEstimate"}],"description":"The estimated lead credits for the people this page can import. Kenso charges nothing for a preview."},"pagination":{"allOf":[{"$ref":"#/components/schemas/TriggerPreviewPagination"}],"description":"How to get the next page."}},"additionalProperties":{},"description":"One page of a trigger preview: sample companies that would match, how many pass each filter step, and an estimated\ncredit cost. The fields present depend on `signalType`. Kenso may add fields to it."},"TriggerPreviewPageResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/TriggerPreviewPage"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"TriggerPreviewPagination":{"type":"object","properties":{"nextCursor":{"type":"string","description":"Send it as `cursor` with the same parameters to get the next page. Null on the last page.","nullable":true},"hasMore":{"type":"boolean","description":"True when there is a next page. Left out for `fundraising`; read `nextCursor` there.","nullable":true}},"additionalProperties":{},"description":"How to get the next page of a trigger preview. Kenso may add fields to it."},"TriggerPreviewRaise":{"type":"object","properties":{"reportedAt":{"type":"string","description":"The day the round was reported, as `yyyy-MM-dd`.","nullable":true},"amountRaisedUsd":{"type":"integer","description":"The money this report adds, in whole US dollars. Null when unknown.","format":"int64","nullable":true},"roundRaisedUsd":{"type":"integer","description":"The total sold in the round so far, in whole US dollars. Null when unknown.","format":"int64","nullable":true},"roundSizeUsd":{"type":"integer","description":"The round's target size in whole US dollars. Null when the round is open-ended or the size is unknown.","format":"int64","nullable":true},"isOpenEnded":{"type":"boolean","description":"True when the round has no set size."},"investorCount":{"type":"integer","description":"How many investors have put money into the round. Null when unknown.","format":"int32","nullable":true},"isNewRound":{"type":"boolean","description":"True when this is the first report of a new round, false for a later update of a round."}},"additionalProperties":{},"description":"A report of a round on a `fundraising` preview. Kenso may add fields to it."},"TriggerPreviewStep":{"type":"object","properties":{"name":{"type":"string","description":"The step: `funding_filters` for `fundraising`; `job_filter`, `resolved_company` for\n`open_roles`; `min_growth_pct`, `min_growth_abs` for `company_headcount_growth`;\n`min_company_size` and `people_filter` for both of those; and `max_contacts_per_company`, always last.","nullable":true},"count":{"type":"integer","description":"How many companies on this page pass the step, or people for `people_filter` and `max_contacts_per_company`. Null when the step could not be counted.","format":"int64","nullable":true},"description":{"type":"string","description":"What the step counts, in words.","nullable":true}},"additionalProperties":false,"description":"One filter step of a trigger preview."},"TriggerResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Trigger"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"TriggerStats":{"type":"object","properties":{"fired":{"type":"integer","description":"How many times the trigger fired in the period.","format":"int32"},"exported":{"type":"integer","description":"How many of those firings added the contact to the campaign.","format":"int32"},"suppressed":{"type":"integer","description":"How many of those firings Kenso suppressed.","format":"int32"},"suppressionBreakdown":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"The suppressed firings by reason, such as `cooldown` or `do_not_contact`, with a count for each."},"lastFiredAt":{"type":"string","description":"When the trigger last fired, at any time, in UTC. Null when it never fired.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"A trigger's firing counts over the requested number of days."},"TriggerStatsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/TriggerStats"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"TriggerTestFire":{"type":"object","properties":{"object":{"type":"string","description":"Always `trigger_test_fire`."},"triggerId":{"type":"integer","description":"The trigger that was tested.","format":"int64"},"signalType":{"type":"string","description":"The trigger's signal type, which is also the sample's type."},"status":{"type":"string","description":"The trigger's status: `active`, `paused` or `archived`."},"shouldFire":{"type":"boolean","description":"True only when every check passed, so the trigger would fire for this sample now."},"rejectedBy":{"type":"string","description":"The name of the first check that failed. Null when all passed.","nullable":true},"checks":{"type":"array","items":{"$ref":"#/components/schemas/TriggerTestFireCheck"},"description":"Every check, in the order Kenso runs them: `status`, `audience_filter`, `parameters` and\n`cooldown`. All of them run, even after one fails."},"evidence":{"description":"The evidence a real firing would record, as a JSON object. Null when the sample did not meet the parameters."},"scheduledFor":{"type":"string","description":"When the trigger delays its firing, the time it would act, in UTC. Null otherwise.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"What a trigger would do with one sample signal. Kenso fires, sends and charges nothing."},"TriggerTestFireCheck":{"type":"object","properties":{"name":{"type":"string","description":"The check's name: `status`, `audience_filter`, `parameters` or `cooldown`."},"passed":{"type":"boolean","description":"True when the sample passed this check."},"message":{"type":"string","description":"What the check found, in plain words."}},"additionalProperties":false,"description":"One check of a trigger test."},"TriggerTestFireResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/TriggerTestFire"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"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."}}}}