Knowledge Center

Update a section

Scope: knowledge_base:write

Role permission: canEdit (OAuth only — API keys carry full workspace permissions)

patch/v1/knowledge-base/sections/{id}

Request

  • Base URL: https://api.vidocu.ai
  • URL: https://api.vidocu.ai/v1/knowledge-base/sections/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://vidocu.ai/oauth/authorize, token URL https://api.vidocu.ai/oauth/token)

Path parameters

idstring required

Request body

namestring
slugstring
descriptionstring nullable
thumbnailUrlstring uri nullable

Publicly reachable image URL shown on the section's card. Square or 16:9 depending on the knowledge base's thumbnail setting.

visibility'public' | 'staff' | 'customers'
positioninteger
parentIdstring nullable

Id of a top-level section to nest under. null (or omitted) makes this a top-level section. One level deep only.

translationsobject

Section name and description in other languages, keyed by locale code (e.g. {"fr": {"name": "Premiers pas"}}). Only the knowledge base's enabled, non-default locales. On update, locales you leave out are kept and null removes one. A missing field falls back to the main-language text.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.