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-highlight
title: "Delete a highlight"
description: "Delete highlight by its id"
sidebar_label: "Delete a highlight"
hide_title: true
hide_table_of_contents: true
api: eJytVMFu2zAM/RWDpw0QknTosMG3AO2wDANWbB12CHxQLCZWY0uqRLfJDP37QNtJnNbtdtgpjvgkPj4+sgGFIffakbYGUrjCEgmTQm+KUm8KSlb7RFNItAIBJDcB0iV8PkQDZAIC5rXXtId02cAKpUc/r6mAdJnFTICTXlZI6EMLCHmBlYS0Ado7hBQCeW02IAB3snIlH2nUqtztN9Xj3ccPdvf7fbEjsvlHpqCphRwpLBREAR7va+1RQUq+RgFGVowqBigBmgt0kgpgXh6DsyZgYC7vZjP+OdfitsBEtXqokyAgILeG0BBfkM6VOpd8YXoX+NZIhXZ1hzlfdN469KS7nCtrt5X024V6rkYUEEh6+rZeB6RB3NTVCj3H0ahXorktrR9V2dQV93CPZWkfgXVgbTYe0YCAVVkjN1XhWtYlQXoARgGEOxp70tRlKVfcFhY/CjCW8J+Aerz0OqB/QZXcoyRU8xEi8cwHy6G+52oOteur6jm3jI75h9myEetBjJzzcnb53DtHUGIsJWtbG/X/nJNbNaJvFFBhCHIzFnuiTfvCCZ/FrpQKqbAKUuhsz4l5XFKYHv0fps1gqiJLi/7hMN21LyGFRirlMYQ4lU5PHy5AwIP0mlvf8u/DnWoHnxVELqTTKfn9pLDSK/QT6RyIkansH0jsOqECkx6edEy4LYO19INF7SdusJyOCnFerqKFQdqDeBTaj0/WV5L5ffl128qozdryda65Y3QxmU1mw93U05nfLEbZz28Wydr6lvoBy5VGAc4GqmRrhn6F9QtZnm2gszebk63+sr67gtnwU1dKbdpZ4441fZ+Xp40ZQEA63J+ZgMIGYlDTrGTAn76MkY/va/S8/bNTm1szKB34W0G6lmXAV2i/+d57823yEs/+UJp96yZeUymAgC3unyz6mEUBBUqFvqXRIeZ5jo4Gd58NIJvmOABX11+vb69BgDx3yxN3tAlGqTVNh7i1WzQxHpkS/2eOMf4BcaSP2A==
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 highlight"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/highlights/{highlightId}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete highlight by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"HighlightId"},"required":true,"name":"highlightId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The deleted highlight","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}}},"404":{"description":"Highlight not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
