> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/delivery-settings/openapi.json](/docs/api/delivery-settings/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Delivery settings

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

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.

Deliverability. 2 endpoints under `https://api.ken.so`. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`: see [Authentication](/docs/authentication.md), [Workspaces](/docs/workspaces.md) and [Errors](/docs/errors.md). OpenAPI for this resource only: [/docs/api/delivery-settings/openapi.json](/docs/api/delivery-settings/openapi.json).

- `GET /v1/delivery-settings` - Return the workspace's delivery settings (`delivery-settings.get`): [/docs/api/delivery-settings/get.md](/docs/api/delivery-settings/get.md)
- `PATCH /v1/delivery-settings` - Update the workspace's delivery settings (`delivery-settings.update`): [/docs/api/delivery-settings/update.md](/docs/api/delivery-settings/update.md)

## Return the workspace's delivery settings

`GET /v1/delivery-settings` - operationId `delivery-settings.get`

| Permission | Rate limit |
| --- | --- |
| Delivery view | 12,000 requests a minute per API key |

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

Needs the `placement_native` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/delivery-settings/GET/v1/delivery-settings)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | 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. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | 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. On by default; false once the workspace turns it off. |

### Request

```bash
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"
```

### Example response

```json
{
  "success": true,
  "data": {
    "placementAutoPause": true
  }
}
```

## Update the workspace's delivery settings

`PATCH /v1/delivery-settings` - operationId `delivery-settings.update`

| Permission | Rate limit |
| --- | --- |
| Delivery edit | 4,800 requests a minute per API key |

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

Needs the `placement_native` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/delivery-settings/PATCH/v1/delivery-settings)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | 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. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | 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 | no | 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. On by default; false once the workspace turns it off. |

### Request

```bash
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
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "placementAutoPause": true
  }
}
```

All resources: [/docs.md](/docs.md).
