Skip to Content
Deliverability

Delivery settings

The workspace's delivery settings: today the placement auto-pause switch. Served only with Ken-Version: 1.1, behind the placement_native feature flag (404 when off). Reading needs Delivery view, changing needs Delivery edit, so workspace admins and Delivery editors can turn it on.

Deliverability2 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.

Return the workspace's delivery settings

GET/v1/delivery-settingsdelivery-settings.get
Permission
Delivery view
Rate limit
12,000 requests a minute per API key
Needs the placement_native feature on your workspace. Until it is on, calls answer 404.

Try it on developer.ken.so

placementAutoPause: when true, a finished placement test where most of a domain's mail lands in spam pauses sending from that domain. On by default; false once someone turns it off. Requires Delivery view.

Request
curl -X GET "https://api.ken.so/v1/delivery-settings" \
  -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 DeliverySettings.

Show the 1 response field and an example

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

Update the workspace's delivery settings

PATCH/v1/delivery-settingsdelivery-settings.update
Permission
Delivery edit
Rate limit
4,800 requests a minute per API key
Needs the placement_native feature on your workspace. Until it is on, calls answer 404.

Try it on developer.ken.so

Absent fields stay unchanged. placementAutoPause: true or false. Returns the settings after the change. Example: { "placementAutoPause": true }. Requires Delivery edit.

Request body

application/json, optional.

FieldTypeRequiredDescription
placementAutoPausebooleanoptionalTurn placement auto-pause on or off.
Request
curl -X PATCH "https://api.ken.so/v1/delivery-settings" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "placementAutoPause": true
}'

Response 200

data is a DeliverySettings.

Show the 1 response field and an example

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


On this page