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

# WhatsApp 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 WhatsApp setting: "Allow WhatsApp to EU, EEA and UK numbers", off by default. Any member reads it; only a workspace admin (members feature) changes it. 404 while the `whatsapp` flag is off.

Inbox. 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/whatsapp-settings/openapi.json](/docs/api/whatsapp-settings/openapi.json).

- `GET /v1/whatsapp-settings` - Return the workspace's WhatsApp setting (`whatsapp-settings.get`): [/docs/api/whatsapp-settings/get.md](/docs/api/whatsapp-settings/get.md)
- `PATCH /v1/whatsapp-settings` - Change the workspace's WhatsApp setting (`whatsapp-settings.update`): [/docs/api/whatsapp-settings/update.md](/docs/api/whatsapp-settings/update.md)

## Return the workspace's WhatsApp setting

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

| Permission | Rate limit |
| --- | --- |
| Any workspace member except a Network member | 12,000 requests a minute per API key |

Needs the `whatsapp` 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/whatsapp-settings/GET/v1/whatsapp-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 `WhatsAppSettings`.

| Field | Type | Description |
| --- | --- | --- |
| `allowEuEeaUk` | boolean |  |
| `updatedAt` | string (date-time) |  |

### Request

```bash
curl -X GET "https://api.ken.so/v1/whatsapp-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": {
    "allowEuEeaUk": true,
    "updatedAt": "2026-09-23T15:02:11Z"
  }
}
```

## Change the workspace's WhatsApp setting

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

| Permission | Rate limit |
| --- | --- |
| The `members` permission | 4,800 requests a minute per API key |

Requires the members feature (workspace admins). `allowEuEeaUk: true` lets touches send WhatsApp to numbers in the
EU, EEA and UK; the workspace answers for the legal basis.

Needs the `whatsapp` 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/whatsapp-settings/PATCH/v1/whatsapp-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 |
| --- | --- | --- | --- |
| `allowEuEeaUk` | boolean | no |  |

### Response 200

`data` is a `WhatsAppSettings`.

| Field | Type | Description |
| --- | --- | --- |
| `allowEuEeaUk` | boolean |  |
| `updatedAt` | string (date-time) |  |

### Request

```bash
curl -X PATCH "https://api.ken.so/v1/whatsapp-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 '{
  "allowEuEeaUk": true
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "allowEuEeaUk": true,
    "updatedAt": "2026-09-23T15:02:11Z"
  }
}
```

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