Sign in
Lists

Update a list

Changed on

Partially update a list. Only the fields provided in the request body will be updated.

patch/lists/{listId}

Request

  • Base URL: https://try.karakeep.app/api/v1
  • URL: https://try.karakeep.app/api/v1/lists/{listId}
  • Auth: HTTP bearer

Path parameters

listIdstring required

The unique identifier of the list.

Example:ieidlxygmwj87oxz5hxttoc8

Request body

namestring
descriptionstring nullable
iconstring
parentIdstring nullable
querystring
publicboolean

Response

The updated list.

idstring required
namestring required
descriptionstring nullable
iconstring required
parentIdstring nullable required
type'manual' | 'smart'
querystring nullable
publicboolean required
hasCollaboratorsboolean required
userRole'owner' | 'editor' | 'viewer' | 'public' required

Changes

  • 6210da080616Revision changes
    • info

      api operation id updateList was added

    • info

      added the non-success response with the status

  • dc0636c164c7Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status