Skip to Content
Copy and personalization

Message templates

WhatsApp message templates, behind the whatsapp flag (404 while off). Writes need workspace_settings.

Copy and personalization5 endpointsKen-Version: 2026-11-02AuthenticationWorkspacesErrors
MarkdownOpenAPI

Path parameters

The endpoints whose path names one of these take it as described here. An endpoint's own table lists a path parameter only when it describes it differently.

NameInTypeRequiredDescription
messageTemplateIdpathinteger (int64)required

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.

List message templates in the current workspace

GET/v1/message-templatesmessage-templates.list
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

Ordered by id. channel accepts only whatsapp. Any member.

Parameters

NameInTypeRequiredDescription
cursorquerystringoptionalThe nextCursor of the previous page. Omit it for the first page.
limitqueryinteger (int32)optionalItems per page, from 1 to 200. Default 50.
channelquerystringoptional
Request
curl -X GET "https://api.ken.so/v1/message-templates?limit=50" \
  -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 list of MessageTemplate. Each item has these fields. The response also carries pagination.

Show the 11 response fields and an example

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

Create a message template

POST/v1/message-templatesmessage-templates.create
Permission
The workspace_settings 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

The author is the caller (user for a person in the dashboard, else agent). A body variable is a source and one of its fields, joined by a dot, in double braces: {{account.name}}, {{person.title}}. The fields are first_name, last_name, full_name and title on person; name on account; and first_name, full_name and company on sender. Up to 6 mediaIds, or a voice, never both; a voice limits the body to 900 characters.

Request body

application/json, optional.

FieldTypeRequiredDescription
channelstringoptional
namestringoptional
bodystringoptional
mediaIdsarray of integer (int64)optional
voiceProviderstringoptional
voiceIdstringoptional
authorSourcestringoptional
Request
curl -X POST "https://api.ken.so/v1/message-templates" \
  -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 '{
  "channel": "string",
  "name": "string",
  "body": "string",
  "mediaIds": [
    812
  ],
  "voiceProvider": "string",
  "voiceId": "string",
  "authorSource": "string"
}'

Response 201

data is a MessageTemplate.

Show the 11 response fields and an example

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

Return one message template in the current workspace

GET/v1/message-templates/{messageTemplateId}message-templates.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

A missing, deleted or cross-workspace id is not_found. Any member.

Request
curl -X GET "https://api.ken.so/v1/message-templates/812" \
  -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 MessageTemplate.

Show the 11 response fields and an example

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

Update a message template

PATCH/v1/message-templates/{messageTemplateId}message-templates.update
Permission
The workspace_settings 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

Only the fields sent are written. mediaIds [] clears; voiceProvider and voiceId go together (both null clears the voice). A template holds images or a voice, never both. An agent may edit a template a person wrote: it then reads authorSource agent.

Request body

application/json, optional: object.

Request
curl -X PATCH "https://api.ken.so/v1/message-templates/812" \
  -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 '{}'

Response 200

data is a MessageTemplate.

Show the 11 response fields and an example

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

Delete a message template

DELETE/v1/message-templates/{messageTemplateId}message-templates.delete
Permission
The workspace_settings 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

Returns 204. An agent may delete a template a person wrote.

Parameters

NameInTypeRequiredDescription
authorSourcequerystringoptional
Request
curl -X DELETE "https://api.ken.so/v1/message-templates/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"

Response 204

Response 204
HTTP/1.1 204 No Content

On this page