Save whether a published article was helpful

Changed on Oct 28, 2026

Called by the public knowledge base after page paint or an explicit interaction, never by its HTML/HEAD renderer. No bearer token or cookie is required. The Origin must be an approved HTTPS host for this desk, and the current publication must still be enabled. Rate limits apply before visitor draws and interaction writes; no raw IP, user-agent, referrer or search text is stored in analytics. Only an explicit click submits a vote. The same vote is a no-op; changing it atomically replaces one sample and advances its version while retaining its original day/category. Vote receipts outlive the visitor by one day; aggregates contain no visitor identifier. Clearing local storage can create a new pseudonym, so these counts do not claim unique people.

post/hd/desks/{desk_id}/kb/articles/{article_id}/helpful

Request

Base URL
https://api.sparkvault.com/v1
Auth
none required
TypeScript
https://skmtc.dev/sparkvault/apis/sparkvault-api/docs/hd/desks/:desk_id/kb/articles/:article_id/helpful/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

desk_idstring required

article_idstring required

Headers

Originstring uri required

The actual HTTPS origin hosting this desk; credentials, paths and nondefault ports are refused.

Request body

visitor_idstring required

The 30-day pseudonym returned by POST /kb/visitor. It is scoped to this desk, never an authentication credential.

release_idstring required

The immutable release ID embedded in the page.

vote'yes' | 'no' required

Response

The saved result.

Changes

Oct 28, 2026a9a10e328ba5 Revision changes
- breaking
  added the new path request parameter article_id
- breaking
  added the new path request parameter desk_id
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Oct 28, 202656d7c265a77a Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status

Operation history (3 revisions)