aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.23.1/API/delete-a-list.api.mdx
blob: 2f3c94a9f246757fb9e9afca292e1534b2954eb8 (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: delete-a-list
title: "Delete a list"
description: "Delete list by its id"
sidebar_label: "Delete a list"
hide_title: true
hide_table_of_contents: true
api: eJx9U9FO2zAU/RXrPm2S18DENOS3SjCNCU1o67SHKg9uctuYJrGxb6BZ5H+frhNogUJfGtvHPueee+4AJYbCG0fGtqDgAmskFLUJJFa9MBSEKUEC6U0AtYRrEyhALiFg0XlDPajlACvUHv28owrUMo+5BKe9bpDQhwQIRYWNBjUA9Q5BQSBv2g1IwJ1uXM1bBk1Z7/pN83B7/tXu/n2pdkS2OGd2QwnC7FclRAke7zrjsQRFvkMJrW4YUI8ACYaLcZoqYDUeg7NtwMAKPp+c8d/zun9aUdiWsCXxSVCFYmXtttF+Kx50EGVyJRGfHbvNukRrSaxt1zL99BYjtXO1KTQjs9vA8CN22NUtFgQSnLcOPZlRamFLfG1alNBgCHpz7OyZN8vxhT0+j/zjNVW2BAVjZUzMXinI2MGQDaOREbjR/v6xjZ2vQcGgy9JjCDHTzmT3pyDhXnujV/WoejoebVrrriZQUBG5oLKMfD+rrPYl+pl2DuQLKxcViukBYdepFRNcjEogxniQv99s5ch7mMInX5iXq0gwUBMI5PTxzfpGs74ffxfJPNOuLV/nmkdFp7OT2clBCL9PcuY3V0fVz2+uxNr6JP0Ry5VGCc4GanSKwBTYad50mriXzw37HL09mGOZhDvKXK1NyzypT8PU02WaigAS1DQeuYTKBuKjYVjpgH98HSNv33XoeaTzfUtT40sT+LsEtdZ1wHd0fvg1pe+jeEvdtKnbPiWn7ngFErbY70c45lFChbpEnxSMh/OiQEcH115NF2fjKd0Xl9eXi0uQoJ+H4kUIEsFRVcMwIhZ2i22MTyKJ16wxxv9jlcnF
sidebar_class_name: "delete 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={"Delete a list"}
>
</Heading>

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



Delete 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={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"204":{"description":"No content - the bookmark was deleted"},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
  
</StatusCodes>