1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
---
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: eJytVk1v4zYQ/SvEnFqAtZ1iF13o5i5aNO0CDbZe9GDoMBbHFhOJ1JJUYlXQf18MJVtyrGRRID4YIjmaj/feDNWCIp85XQVtDSTwpVIYSBTaB7FrhA5eaAUSAh48JFv4pH3wkErwlNVOhwaSbQs7QkduXYcckm3apRIqdFhSIOejgc9yKhGSFkJTESTgg9PmABLoiGVV8JYmrYpjcyif7j/8Yo//vc+PIdjsA0fXIZpw9FsFnQRHX2vtSEESXE0SDJZsUPQGEjQXU2HIgbNha/LhV6sazuGy5E1OQmFAEayoY/kL8bcpGhFyEntNhfKisbV4QhNGG2GIFC93JCpnH7UitQAJmTWBTOAwWFWFzpDDLO89x5oBwu7uKQsgoXK2Ihc0eT7t67mGq9TmE5kDA30jocTjebVadfKysuu3TV0UuGMoe9Qm3lYX3t5Hbzqbc9NFdskw0N+N0Un4WpNrvlcLO613hc4mhjtrC0IDXfwxi76yxvcA/bxazVPZ06OihN+ODz1TaydfoOn/EvFmUPcGM01m6pK7t0RTYwESfIkucBsr2mNdBEhOZ68RdhXvFcqmLbqFOEMiWEOpk8LObtLLRoee9Xerd9dE87kwNoi9rY16O5ozq+b5LMl7PMydPas0ehjt00G7JYXcqn4mZXksn3UPS5apX7b94OqYGnKPp7FZuwISaFEpR953S6z08vEGJDyi08xETHo47lE60ZmHUPlkuQyuWTygwweiaoFVBXKmZwYPwu7j0PtrsBd9LkzEZOL/w1j2kadz/wwMR+Y6ohlrIhqBHB5+t65EzvDPfzcRPebo8zigfztdCKchOOrvMvHzdt8743psmXFv0PTEaJDuqf/M3nJIhr53f7NYLVaTu+cMyvrudhbE9d2t2Ft3iSAjzo1ifSjRTIoaLlo8zalnA+Os55dv5B7tQMewrArUhuNEwbSDuLbxOvQgIRnuxVRCbn3go7bdoacvrug63h7w2aajtqIClfb8rCDZY+HplTx/+Dx0wY/ipeyGTTRNlHBR8wokPFAz3t1d2knICRW5mEF/+LGP89OGXYwvX/V6J09vrLOMqvCqbTrpy7v15uMfLNLhG6GMkwAcPoGM/zFTGwuP2o97LRRoDnWcDNA7ZUnjZUc864BY1iwWbdtbbOwDma47QxN4zch03Tdsok9Y
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":100},"description":{"type":"string","nullable":true,"minLength":0,"maxLength":500},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"query":{"type":"string","minLength":1},"public":{"type":"boolean"}}}}}}}
>
</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},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
