---
id: update-a-list
title: "Update a list"
description: "Update list by its id"
sidebar_label: "Update a list"
hide_title: true
hide_table_of_contents: true
api: eJytVd9v2zYQ/leIe9oAznaKDCv05hUrmq7Ags7FHgw/0OLZYiKRLHlKrAn634ejZMtOlBQD4gdD5B3vx3ff3bWgMebBeDLOQgbfvFaEojSRxLYRhqIwGiSQ2kfI1vDFRIqwkRAxr4OhBrJ1C1tUAcOypgKy9abbSPAqqAoJQ0wKMS+wUpC1QI1HyCBSMHYPEvCgKl/ylUGjy0Ozrx7v3v/mDv/+WhyIXP6evRtKKuz9RkMnIeD32gTUkFGoUYJVFSuUvYIEw8l4RQVwNKyNkX53uuEYLlNeFSi0IiXIiTqlPxN/2bIRVKDYGSx1FI2rxaOyNOoIi6j5uEXhg3swGvUMJOTOElpiN8r70uSK3czvIvuaAMJt7zAnkOCD8xjIYGRpn89zuCpjv6DdM9BXEip1OJ6uF528TOz5Y1uXpdoykj1oZ8YWF8auFmzN5FNmulRctIzzD310Er7XGJofpdKlHxcqemdjj8G7xWK6Wn0FdGLp20FuJvLp5AuV+L9gvxmcvcJEH9m64gatlK1VCRJipQJxp2rcqbokyI6y14ryxN9Fp60hjYIEyJDOWfCbyzaFvqDXi+vnNWS5sI7EztVWv10Fc6enS1VhjGo/JXuSYLIw6m8GWlZIhdP9RMmLlDXTFubMwDhv+7HTMeoYHo5Drw4lZNAqrQPG2M2VN/OHK5DwoIJhkFPQg7hH6VipgsjHbD6n0MzuVVD3iH6mvAc50Q6DBeF2aWT9OeiLPhYuxNm8/pux7D2fT+0TMOyZ80hqkA1KIIePjy5UiiP8/M8qocc1+jqO1z+O4/w4wkZqXQZ+uu7bYjyP3TDeDXQ9q6ixO8dOGOze4NVsMVuc7YoTDMvbm0nYlrc3YufCJWaMMbeki1Qpe5bGsBjVceg86f4Tg1/eoD2+hAea+1IZy34SRdqBTuu0viJIyIY9tpFQuEgsatutivgtlF3H1wMi683IpsQ5bSJ/a8h2qoz4Spw/fR14/7N4KbrhUtkmkbas+QQS7rEZd2236SQUqDSGFEEv/ND7+WXFJsbHz7q7k8cXyzxHT6/qbs468Xa5+vCJaTns9Cr1PgT1CDL9p0hdSjyxPd21UCq7r9MsgN4ok1hd9sATzqe0JrFo215j5e7Rdt0JGuIzI9N1/wHzITRF
sidebar_class_name: "patch api-method"
info_path: API/karakeep-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a list"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/lists/{listId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update list by its id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","nullable":true,"minLength":0,"maxLength":100},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"query":{"type":"string","minLength":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The updated list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
  
</StatusCodes>