aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.23.1/API/create-a-new-list.api.mdx
blob: 2105ee77b6b377d6654c3b2117ba44e68c077a11 (plain) (blame)
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
72
---
id: create-a-new-list
title: "Create a new list"
description: "Create a new list"
sidebar_label: "Create a new list"
hide_title: true
hide_table_of_contents: true
api: eJy1VU1v2zAM/SsGz1o+hp58S4sN61BgxZphhyAH1mZitbakSnLbwNB/Hyg7sZN6KQZ0F8OSSJF875FqICeXWWm81ApSuLKEnhJMFL0kpXQeBHjcOkhXcCOdd7AW4CirrfQ7SFcN3BNasovaF5Cu1mEtwNJTTc5f6nwHaXMSYFlQvDfxOsliMBCQaeVJebZGY0qZIVtPHxy7NOCygirkP78zBCno+wfKODVjtSHrJTk+VVjRwMp5K9UWBFRS3ZDacoZzARW+7lcXsyCO8zvrPDtyns/YW2ZjbkF0G2/vI1VXjGaFqsYSBLgKrWdYc9pgXXpI92dBwFNNdvdeTUGAQUvKX+djpqouS7wvCVJvawqhZUhayjmPCFpXxzqE9tgZrVwL6ufZfJzFlr18r5IP4lCOlBDEX6h9n72T2s/w9Q8I/ndyzzMmcxBHtA2SXwvw0rNnbFdoCb2Yzd5yeIl50rXqx9GX6Xycp4qcw+3Y2Ul18YbePkoy+vtC55CC0TFfgyx9mJZxKPFMss9kXRxJtS0hhQbz3JJzYYpGTp/nIOAZrWRcY6rdcQvMnpzCe+PS6dTb3aTQaHOyEzQGxEgDdBckepP4gpLOPGkzYeQHo/KO8WvjDgfmAQyOy1VEM0g7IxDdz1dtK+T8vv9eRsSYl5/9nP3yipUpqR+CvZaO8z5st33Qr7s8DsLttNkb9P0xYFWqjeagDH0bYD6ZTWbQq/Bbh8ri9noUxMXtdbLRNiK4t2XAuSO18xWqQVFjr9PJADjoePwpa6v09OqnpkSpOE6US9MpagXl/pkrWGnpCprmHh39smUIvN0hs1r3eoovn4CCMCcbJfhIDN5Vm8ynJYdl87Lm8G8aLIi9xyLLyPiztutBM9z+uFuySLqntordBxZfQMRvCiBAR3Ci9uJeAyWqbR27Edo7WVJ4rMgTBcaquiNUu0GGTdNaLPUjqRBAdKV4XkPgBv4D5V7dCQ==
sidebar_class_name: "post api-method"
info_path: API/hoarder-api
custom_edit_url: null
hide_send_button: true
---

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={"Create a new list"}
>
</Heading>

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



Create a new list

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

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"description":"The list to create","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","minLength":0,"maxLength":100},"icon":{"type":"string"},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","minLength":1},"parentId":{"type":"string","nullable":true}},"required":["name","icon"]}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"The created 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"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
  
</StatusCodes>