Delivery settings
The Delivery settings endpoints of the Kenso API.
Return the workspace's delivery settings
GET
/v1/delivery-settingsdelivery-settings.getNeeds the placement_native feature on your workspace. Until it is on, calls answer 404.
placementAutoPause: when true, a finished placement test where most of a domain's mail lands in spam pauses sending from that domain. False until someone turns it on. Requires Delivery view.
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 DeliverySettings.
Field
Type
Description
placementAutoPause
boolean
When true, a finished placement test where most of a domain's mail lands in spam pauses sending from that domain. Off by default.
Request
curl -X GET "https://api.ken.so/v1/delivery-settings" \ -H "Authorization: Bearer $KEN_API_KEY" \ -H "Ken-Version: 1.1" \ -H "X-Ken-Workspace-Id: $KEN_WORKSPACE_ID"
Response 200
{
"success": true,
"data": {
"placementAutoPause": true
}
}Update the workspace's delivery settings
PATCH
/v1/delivery-settingsdelivery-settings.updateNeeds the placement_native feature on your workspace. Until it is on, calls answer 404.
Absent fields stay unchanged. placementAutoPause: true or false. Returns the settings after the change. Example: { "placementAutoPause": true }. Requires Delivery edit.
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.Request body
application/json, optional.
Field
Type
Required
Description
placementAutoPause
boolean
optional
Turn placement auto-pause on or off.
Response 200
data is a DeliverySettings.
Field
Type
Description
placementAutoPause
boolean
When true, a finished placement test where most of a domain's mail lands in spam pauses sending from that domain. Off by default.
Request
curl -X PATCH "https://api.ken.so/v1/delivery-settings" \
-H "Authorization: Bearer $KEN_API_KEY" \
-H "Ken-Version: 1.1" \
-H "X-Ken-Workspace-Id: $KEN_WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"placementAutoPause": true
}'Response 200
{
"success": true,
"data": {
"placementAutoPause": true
}
}