summarize-a-bookmark.api.mdx•3.28 kB
---
id: summarize-a-bookmark
title: "Summarize a bookmark"
description: "Attaches a summary to the bookmark and returns the updated record."
sidebar_label: "Summarize a bookmark"
hide_title: true
hide_table_of_contents: true
api: eJytVUuP2zYQ/ivCnFqAsJwiRQPdnEPQ7SWL7BY9GD6MxbHFXYlkyJFjR+B/L4aSX7vO45CTJM7rm4/fjAbQFOtgPBtnoYIFM9YNxQKL2HcdhkPBruCGirVzzx2G5wKtLgJxH2zMht5rZJKz2gU9AwWM2wjVEt5PIRFWCiLVfTB8gGo5wJowUFj03EC1XKWVAo8BO2IKMTvEuqEOoRqAD56ggsjB2C0ooD12vpUjQ0a3+8O2+/L07i+3//pns2d29TtBYDi7HBHcaUgKAn3uTSANFYeeFFjsxGl9dlJghAWP3ICgChS9s5GiIPljPpfHNWGPFwycKPpiuDnyBwpqZ5ksSzB635oaJbh8ipLhRq9u/UQ1gwIfnKfAZqxv9Gs+koI6kFRf8E1r57TZmNtmBbZvW1wLVcJIOhH3E54Y6sbs6BLT2rmW0ErZDe6cXPe37IzbrbHbB0bu44/rKSDbd6Kp2Nc1xQhSwrR9IKGJrJaoVVJgHf8c/uP1/Nj3SjlLuYZL0q8ovqDlioOXDa9SkrRv529fK+qo2cI6Ljaut/rXSah2+gY7IhOKEbe3bC+6zxnO/rmRHM+N0zI6LuayMkEVlMeRiOVwHrNUjuSbr5IqUtgdx74PLVQwoNaBYkwlelPu3oCCHQYjV5K7mMwjdRvsW4YKGmYfq7LkcJg1DoOmMEPvQd0Y2ClB4TZ5g03uxYgEUkoX++pBqB3rXm6tE09SV7rIbiLy7ARqevngQoeC75//HjOZxm6chEvPI6I3s/lsfrG0/p7gLO7vbqJf3N8VGxcy9KOvdJpUZr/DLIlpuT0cmS7wtJ9eZh3O8vpFP4CRGqY9l75Fk0c+3+0wKWN52royytXVCj6LY6WgET1VSxiGNUb6N7QpyfHnnmR2l6uzNLKAtInyrqHaYBvpO43+9mlS9e/FtxBPh2gPWYFtL1+g4JkO17+NJJunIdQUMorRYVHX5Pki9NXkis5Ok3P/8eFRFsi1vF7IKae/iWsYRo9H90w2pRNMlm9BmNL/WQ2+Kg==
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={"Summarize a bookmark"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/bookmarks/{bookmarkId}/summarize"}
context={"endpoint"}
>
</MethodEndpoint>
Attaches a summary to the bookmark and returns the updated record.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The updated bookmark with summary","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>