create-a-new-bookmark.api.mdx•6.54 kB
---
id: create-a-new-bookmark
title: "Create a new bookmark"
description: "Create a new bookmark"
sidebar_label: "Create a new bookmark"
hide_title: true
hide_table_of_contents: true
api: eJzVWMFu4zYQ/RVjzmzsFD3p5iy6aIq2GzQpejB0GEtjixuJ1JKUs66gfy+GpC3FkRO5WRQtAgSyOEMOH98M36iFnGxmZO2kVpDAB0PoaIYzRU+ztdaPFZpHEOBwayFZwU18ZSEVYClrjHR7SFYtrAkNmWXjCkhWaZcKMPSlIetudL6HpD1Z6KGg4/wzp2eZXxgEZFo5Uo49sK5LmSF7zD9bdmvBZgVV6EfL8tPGL+32NUECev2ZMgcCaqNrMk6SZTsnXUn+IZhZZ6TaggDVlCWuecyZhgRU+PUXUlvewPVisegEoMkKuaN84L3WuiRU0AnY4E7z/s+NK+1G1u0E2Kaq0OxHxwIO+dK9HXHXdaIFrWgaDH705ZykmopPtpTqEdJOQGPKMbuNNhU6SKAxkgOtDWUGn0rKlwGl23xkQ12ggTQM0iqMhiVSDv59ITv66nzI/mEUad2YjP4Y29GZ0A5zvjc2tJZCcP7p4Q1zWeGWl6/zTe80iqiAjSzpN6zOcOviHffx9cumHf91wcPWWtmw6+8X1+OpHGk7LBmTE/l1oOU4CK/kSSeg0rncyIlpJKaWiHdXBIfbrVTbe4eusVNK0oEetskyspbTEGXZGE8VUjl7pWdLzUj8Z0vPGCq+5h8N0RjcgwDpqLL/+NzUOeKic5gVlN+MBndMKwkCiqZCBekpn2UOcf5ns3m7ARn/nYJ5Eaue5dMEe18tRnP8nPHyXD0Z40hmiJQttLvEa9OU5R2vFDLkEtcXV8klzjuZk74oUNzJbCLQhavKDz113rQ/bGOaNTau0GYaRM26lLagadY5OrqLHtNAYY9fY9Gcojz+s9f6xFD/19f8WM5egIgAK/8aTquaak1mlM+TuX+Jtng36o16VPpp5ArwDixd4nLf/v6adMx9BT3s+374Zo1KkbmNXDgpnBBLGttFMeWrG4zUSc65c1D427CPNu1GDXoZ9Uw0DYTOM1VzKmGiSOiJcsQ9Pd5/x54RgqD8YbF4qSFvMJ/FfvHbScdM5+NaoyJrGfw3JbKfobf3ktj7u0LnkECtfbw1ctMI8/WxO+bm2OzIWC80vEKAFvPckLXdHGs5313zSaORnEQ+3DgcwNlgU3K3VThX22Q+d2Z/VWg0OZkrrGsQIyI8TjDTm5kraBbNZyESRn/Qs98zhmHdYed+BITX5V14M1ax3ohJ6R8+HrrBn/988Kjx2fzeN/w/fsWqjuon0uCYJb2GDiJ3qJrDmyBne4+jau1fDfR//zLG7pVZ1GX94GjDOiCFVBvN8fKpBUyvrxZXC+iJ/FMEdHl3O4r/8u52ttHGg3+w5bPi+1tbx6I1aaMCPvul5UQLHlPh/KeZsGm+0eZ1idJ3GlGTBmKuYD38bFMwaZMVtO0aLd8ZXcevvzTEEK/Snpb+S46AgjBn5bFq4ZH4FKIk+i5W9h2Wja+wp7nKlT54LLOMaveqbTrIq7tP9w++AIZPR5VPZDD4BML/TwAEaA+Sp7B/10KJatv4xIYwZxdV1rAde07kYSOAaj+IsG2DxYN+JNV1IOJWHP8G3x7/DcCdo/I=
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 bookmark"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/bookmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new bookmark
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"description":"The bookmark to create","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"title":{"type":"string","nullable":true,"maxLength":1000},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"note":{"type":"string"},"summary":{"type":"string"},"createdAt":{"type":"string","nullable":true}}},{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string","format":"uri"},"precrawledArchiveId":{"type":"string"}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["type","assetType","assetId"]}]}]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"201":{"description":"The created bookmark","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},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>