v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB

Library

Update a library

Update name and/or description of an existing library.

patch/libraries/{library_id}

Path parameters

library_idinteger required

Query parameters

cookie_namestring nullable

Request body

namestring nullable

New display name for the library.

descriptionstring nullable

New description for the library.

Example request

{
  "name": "Platform Knowledge Base",
  "description": "Updated docs and runbooks."
}

Response

Successful Response

created_atstring date-time

UTC timestamp when the record was created.

updated_atstring date-time

UTC timestamp when the record was last updated.

creator_user_idinteger required

ID of the user who created the record.

updater_user_idinteger nullable

ID of the user who last updated the record, if any.

idinteger

Primary key for the library.

tenant_idinteger required

ID of the tenant that owns the library.

namestring required

Name of the library.

descriptionstring nullable

Optional description of the library.

Example response

{
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-16T08:00:00Z",
  "creator_user_id": 12,
  "updater_user_id": 12,
  "id": 1,
  "tenant_id": 1,
  "name": "Company Knowledge Base",
  "description": "Shared documents for the whole company"
}