SapanBaseDevelopers

Archive an article

Removes the article from the live knowledge base (content and history are kept; recoverable via unarchive). HelpBento never hard-deletes articles. Scope: content:write.

POSThttps://api.helpbento.com/v1/articles/{id}/archive

Authentication

AuthorizationstringheaderBearer <token>required

An API key, e.g. hb_live_… (live) or hb_test_… (test).

Path parameters

1 param
  • idstringrequired

Header parameters

1 param
  • Idempotency-Keystringlength: 0…255

    Optional idempotency key (1–255 chars). Repeating a mutating request with the same key within 24h replays the original response instead of re-executing it; a concurrent in-flight request with the same key returns 409. Use a unique key (e.g. a UUID) per logical operation so network retries are safe.

Responses

  • articleIdstring
  • statusstringarchived
Errors