Skip to Content
Inbox

WhatsApp settings

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.

Inbox2 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 WhatsApp setting

GET/v1/whatsapp-settingswhatsapp-settings.get
Permission
Any workspace member except a Network member
Rate limit
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

Request
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"

Response 200

data is a WhatsAppSettings.

Show the 2 response fields and an example

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

Change the workspace's WhatsApp setting

PATCH/v1/whatsapp-settingswhatsapp-settings.update
Permission
The members permission
Rate limit
4,800 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

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.

Request body

application/json, optional.

FieldTypeRequiredDescription
allowEuEeaUkbooleanoptional
Request
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
}'

Response 200

data is a WhatsAppSettings.

Show the 2 response fields and an example

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


On this page