Skip to Content

Kenso API changes on 2026-11-05

Every change on this day, by version. The changelog lists the newest days and links the older ones.

27 changesRSS feed
Markdown

Version 2026-11-02

2026-11-05 27 changes

  • Added message-templates.create
    Added message-templates.create: a WhatsApp message template with {{variables}} such as {{person.first_name}}, up to 6 mediaIds and an optional voiceProvider and voiceId. It answers 404 until WhatsApp is turned on for the workspace.
  • Added message-templates.delete
    Added message-templates.delete. An agent cannot delete a template a person wrote. It answers 404 until WhatsApp is turned on for the workspace.
  • Added message-templates.get
    Added message-templates.get, one WhatsApp message template. It answers 404 until WhatsApp is turned on for the workspace.
  • Added message-templates.list
    Added message-templates.list, the workspace's WhatsApp message templates by id, with an optional channel filter (whatsapp). It answers 404 until WhatsApp is turned on for the workspace.
  • Added message-templates.update
    Added message-templates.update, which writes only the fields sent. An agent cannot edit a template a person wrote. It answers 404 until WhatsApp is turned on for the workspace.
  • Added delivery-settings.get
    Added delivery-settings.get (GET /v1/delivery-settings): the workspace's delivery settings. placementAutoPause says whether a finished placement test where most of a domain's mail lands in spam pauses sending from that domain; it is false until someone turns it on. Answers 404 until Kenso placement tests are on for the workspace.
  • Added delivery-settings.update
    Added delivery-settings.update (PATCH /v1/delivery-settings): turns placement auto-pause on or off, for example { "placementAutoPause": true }. Absent fields stay unchanged. Answers 404 until Kenso placement tests are on for the workspace.
  • Added placement-tests.availability
    Added placement-tests.availability (GET /v1/placement-tests/availability): whether the workspace runs placement tests on the Kenso seed network (enabled), whether its plan allows them (planAllowed), which seed providers run tests now, whether a test can add the copy check (control), and how many tests the budget leaves today and this month.
  • Changed placement-tests.create
    Placement tests can run on the Kenso seed network. Added optional request fields subject and body (custom copy, sent together, no campaign needed) and control (also send a plain message from the same senders, to tell a copy problem from a domain problem). inboxId tests one inbox and domainId a domain's inboxes; with neither, the test uses the campaign's senders. The call can now answer 200 with the test already running for that scope. Added optional response fields scope, verdict, progress, hasControl, providersTested and control.
  • Changed placement-tests.get
    Added optional response fields for tests on the Kenso seed network: scope, verdict (cause and summary), progress (planned, sent, read, waiting, failed, finalBy), hasControl, providersTested and control (the copy check's results). Each provider adds tested, folders, authentication (SPF, DKIM, DMARC and compauth pass counts), microsoft (median SCL and BCL) and medianArrivalSeconds. Each seed adds arm, status, tab, authentication, microsoft and arrivalSeconds.
  • Added placement-tests.list
    Added optional query parameters inboxId and domainId to placement-tests.list. Pass exactly one of campaignId, inboxId or domainId.
  • Changed placement-tests.list
    Added the same optional fields as placement-tests.get to each test in the placement-tests.list response: scope, verdict, progress, hasControl, providersTested, control, and the new provider and seed fields.
  • Changed people.intake
    The person model gains four optional WhatsApp fields: phones[].whatsapp (on, off or unknown: whether that number is on WhatsApp, from a check in the last 30 days), phones[].whatsappCheckedAt (when that check ran), phones[].whatsappOptOutAt (when WhatsApp to that number stopped, by the person's stop or the number's) and whatsappOptOutAt (when the person asked not to get WhatsApp messages). people.intake returns the person model but never fills them, so its response does not change. They are returned only on the people get, list and search reads, and only for a workspace with the whatsapp feature on, which is off for every workspace for now.
  • Added whatsapp-accounts.create-connect-session
    Added whatsapp-accounts.create-connect-session (POST /v1/whatsapp-accounts/connect-sessions), which starts a hosted session to connect a WhatsApp account and answers 201 with its url and whatsappAccountId. Omit whatsappAccountId to connect a new account (it shows as connecting until the scan completes), or pass it to reconnect one. A new account costs 1,500 credits a month and needs the first month up front: without it the call answers 400 validation_failed. Needs the whatsapp feature, which is off for every workspace for now: until it is on, the call answers 404.
  • Added whatsapp-accounts.delete
    Added whatsapp-accounts.delete (DELETE /v1/whatsapp-accounts/{whatsappAccountId}), which removes a WhatsApp account, ends its WhatsApp session and stops its monthly charge. It answers 204. Needs Delivery edit. Needs the whatsapp feature, which is off for every workspace for now: until it is on, the call answers 404.
  • Added whatsapp-accounts.get
    Added whatsapp-accounts.get (GET /v1/whatsapp-accounts/{whatsappAccountId}), which returns one WhatsApp account of the workspace with the same fields as whatsapp-accounts.list. Needs the whatsapp feature, which is off for every workspace for now: until it is on, the call answers 404.
  • Added whatsapp-accounts.list
    Added whatsapp-accounts.list (GET /v1/whatsapp-accounts), which lists the WhatsApp accounts connected to the workspace: each one's number, status, ramp stage, pause, working hours, daily new-chat and message caps, and today's usage. Needs the whatsapp feature, which is off for every workspace for now: until it is on, the call answers 404.
  • Added whatsapp-accounts.update
    Added whatsapp-accounts.update (PATCH /v1/whatsapp-accounts/{whatsappAccountId}), which changes a WhatsApp account's daily caps (dailyNewChatCap, dailyMessageCap, or resetCaps for the ramp defaults), its timezone and working hours (workingHoursSchedule, resetWorkingHours), and pauses or resumes it (paused). Absent fields stay unchanged. A cap above its ceiling answers 400 validation_failed, and resuming an account WhatsApp restricted answers 409 conflict. Needs Delivery edit. Needs the whatsapp feature, which is off for every workspace for now: until it is on, the call answers 404.
  • Added whatsapp-settings.get
    Added whatsapp-settings.get (GET /v1/whatsapp-settings), which returns the workspace's WhatsApp setting: allowEuEeaUk (whether touches may send WhatsApp to numbers in the EU, EEA and UK; off by default) and updatedAt. Needs the whatsapp feature, which is off for every workspace for now: until it is on, the call answers 404.
  • Added whatsapp-settings.update
    Added whatsapp-settings.update (PATCH /v1/whatsapp-settings), which turns allowEuEeaUk on or off. With it on, touches send WhatsApp to numbers in the EU, EEA and UK, and the workspace answers for the legal basis. Workspace admins only. Needs the whatsapp feature, which is off for every workspace for now: until it is on, the call answers 404.
  • Added linkedin-accounts.reset-ramp
    Added linkedin-accounts.reset-ramp.
  • Changed analytics.get-reply-classifications
    Documentation fix: the reference no longer lists the configurationId and byConfiguration query parameters or a configurationId field on breakdown rows. Replies are not tied to a sending configuration, so configurationId was always refused with 400 validation_failed, byConfiguration only ever returned one Unattributed row holding everyone, and the row field was never sent. Only the documentation changed: a request that still sends them gets the same response as before.
Optional fields added on 5 operations
  • Changed campaigns.list-linkedin-accounts
    Added optional fields data[].ramp, data[].rampPlansEnabled, data[].rampStartedAt, data[].ramp[].action, data[].ramp[].ceiling, data[].ramp[].fullVolumeOn, data[].ramp[].start, data[].ramp[].stepPerWeek, data[].ramp[].todayCap and data[].ramp[].weekIndex to the campaigns.list-linkedin-accounts response.
  • Changed campaigns.replace-linkedin-accounts
    Added optional fields data[].ramp, data[].rampPlansEnabled, data[].rampStartedAt, data[].ramp[].action, data[].ramp[].ceiling, data[].ramp[].fullVolumeOn, data[].ramp[].start, data[].ramp[].stepPerWeek, data[].ramp[].todayCap and data[].ramp[].weekIndex to the campaigns.replace-linkedin-accounts response.
  • Changed linkedin-accounts.get
    Added optional fields data.ramp, data.rampPlansEnabled, data.rampStartedAt, data.ramp[].action, data.ramp[].ceiling, data.ramp[].fullVolumeOn, data.ramp[].start, data.ramp[].stepPerWeek, data.ramp[].todayCap and data.ramp[].weekIndex to the linkedin-accounts.get response.
  • Changed linkedin-accounts.list
    Added optional fields data[].ramp, data[].rampPlansEnabled, data[].rampStartedAt, data[].ramp[].action, data[].ramp[].ceiling, data[].ramp[].fullVolumeOn, data[].ramp[].start, data[].ramp[].stepPerWeek, data[].ramp[].todayCap and data[].ramp[].weekIndex to the linkedin-accounts.list response.
  • Changed linkedin-accounts.update
    Added optional fields ramp, ramp{}.ceiling, ramp{}.start and ramp{}.stepPerWeek to the linkedin-accounts.update request. Added optional fields data.ramp, data.rampPlansEnabled, data.rampStartedAt, data.ramp[].action, data.ramp[].ceiling, data.ramp[].fullVolumeOn, data.ramp[].start, data.ramp[].stepPerWeek, data.ramp[].todayCap and data.ramp[].weekIndex to the linkedin-accounts.update response.

More