Skip to Content
AI

AI line holds

Contacts the AI line check held because their personalization lines failed it: list them and approve one to send its lines as they are.

AI2 endpointsKen-Version: 2026-11-02AuthenticationWorkspacesErrors
MarkdownOpenAPI

Headers

The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.

NameInTypeRequiredDescription
Ken-Versionheaderstring, one of: 2026-11-02, 1.1optionalThe 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 date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.
X-Ken-Workspace-Idheaderinteger (int64)optionalThe 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.

List a campaign's held contacts

GET/v1/campaigns/{campaignId}/ai-line-holdsai-line-holds.list
Permission
Campaigns view
Rate limit
12,000 requests a minute per API key

Try it on developer.ken.so

Returns the contacts the line check held in the campaign, newest hold first, with the reasons and the lines each hold keeps. A contact stays on the list until you approve it or its lines are written again.

Errors:

  • 400 validation_failed: limit is not from 1 to 200, or cursor is not valid.
  • 404 not_found: the campaign is not in this workspace.

Requires Campaigns view.

Parameters

NameInTypeRequiredDescription
campaignIdpathinteger (int64)requiredThe campaign to read.
limitqueryinteger (int32)optionalHolds per page, from 1 to 200. Default 50.
cursorquerystringoptionalThe nextCursor of the previous page. Omit it for the first page.
Request
curl -X GET "https://api.ken.so/v1/campaigns/812/ai-line-holds?limit=50" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"

Response 200

data is a list of AiLineHold. Each item has these fields. The response also carries pagination.

Show the 4 response fields and an example

The fields and an example are also on this endpoint's Markdown page.

Approve a held contact

POST/v1/campaigns/{campaignId}/ai-line-holds/{contactId}/approveai-line-holds.approve
Permission
Campaigns edit
Rate limit
4,800 requests a minute per API key

Try it on developer.ken.so

Releases a held contact with the lines its hold keeps. Those lines become the contact's personalized lines and the contact counts as personalized, so it can send. Approving costs no credits.

Errors:

  • 404 not_found: the campaign or the contact is not in this workspace, or the contact is not in this campaign.
  • 409 not_held: the contact has no hold in this campaign. It was never held, was already approved, or its lines were written again.
  • 409 conflict: the contact already has a live line for a variable the hold keeps, or the hold keeps no lines. Nothing changes. Regenerate the contact's lines instead.

Requires Campaigns edit.

Parameters

NameInTypeRequiredDescription
campaignIdpathinteger (int64)requiredThe campaign that held the contact.
contactIdpathinteger (int64)requiredThe held contact.
Request
curl -X POST "https://api.ken.so/v1/campaigns/812/ai-line-holds/812/approve" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"

Response 200

data is a AiLineHoldApproval.

Show the 2 response fields and an example

The fields and an example are also on this endpoint's Markdown page.


On this page