Back to Karakeep

Replace asset on a bookmark

docs/docs/api/replace-asset-on-bookmark.api.mdx

0.31.02.1 KB
Original Source

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={"Replace asset on a bookmark"}

</Heading>

<MethodEndpoint method={"put"} path={"/bookmarks/{bookmarkId}/assets/{assetId}"} context={"endpoint"}

</MethodEndpoint>

Replace an existing asset on a bookmark with a different previously uploaded asset.

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

</Heading>

<ParamsDetails parameters={[{"schema":{"type":"string","description":"The unique identifier of the bookmark.","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"},{"schema":{"type":"string","description":"The unique identifier of the asset.","example":"ieidlxygmwj87oxz5hxttoc8","title":"AssetId"},"required":true,"name":"assetId","in":"path"}]}

</ParamsDetails>

<RequestSchema title={"Body"} body={{"description":"The ID of the new asset to replace the existing one.","content":{"application/json":{"schema":{"type":"object","properties":{"assetId":{"type":"string","description":"The ID of the new asset to use as a replacement."}},"required":["assetId"]}}}}}

</RequestSchema>

<StatusCodes id={undefined} label={undefined} responses={{"204":{"description":"No content — asset was replaced successfully."},"401":{"description":"Unauthorized — the Bearer token is missing, invalid, or expired.","content":{"text/plain":{"schema":{"type":"string","example":"Unauthorized"}}}},"404":{"description":"Bookmark or asset not found.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable error message."}},"required":["code","message"],"title":"Error"}}}}}}

</StatusCodes>