Deliverability rules
The Deliverability rules endpoints of the Kenso API.
List the deliverability rules in force for the workspace
GET
/v1/deliverability-rulesdeliverability-rules.listThe rules in force for the workspace, in this order: open_pixel, click_host, recipient_format and smtp_inbox_limits. A workspace the last three are not in force for yet sees only open_pixel. Each has code, title, sentence (the rule's text, to quote unchanged), severity (enforced or warning), fixUrl (a relative app link, omitted when there is none) and warningCodes: the warnings[].code values GET /v1/campaigns/{campaignId}/launch-readiness uses when a campaign breaks the rule. A warning never blocks a launch. Not paged. Any workspace member.
Parameters
Name
In
Type
Required
Description
Ken-Version
In: header
string, one of: 2026-11-02, 1.1
optional
The API version, a date in
YYYY-MM-DD form. 1.1 is another name for the first dated version. 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-Id
In: header
integer (int64)
optional
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.Response 200
data is a list of DeliverabilityRule. Each item has these fields.
Field
Type
Description
code
string
Stable code:
open_pixel, click_host, recipient_format or smtp_inbox_limits. New codes may be added.title
string
A short name for the rule, ready to show.
sentence
string
The rule's text. Quote it unchanged.
severity
string
enforced: Kenso applies it to every campaign and no setting changes it. warning: launch readiness warns when a campaign breaks it, and never blocks the launch.fixUrl
string
Relative app link to the page where a break of the rule is fixed. Omitted when there is none.
warningCodes
array of string
The launch readiness
warnings[].code values that report a break of this rule. Empty for an enforced rule.Request
curl -X GET "https://api.ken.so/v1/deliverability-rules" \ -H "Authorization: Bearer $KEN_API_KEY" \ -H "Ken-Version: 1.1" \ -H "X-Ken-Workspace-Id: $KEN_WORKSPACE_ID"
Response 200
{
"success": true,
"data": [
{
"code": "string",
"title": "string",
"sentence": "string",
"severity": "string",
"fixUrl": "https://example.com",
"warningCodes": [
"string"
]
}
]
}