Skip to content

API v2: add an endpoint to remove a bookmark #2152

Description

@codybrom

Summary

The API v2 lets authenticated users create bookmarks, and read them, but there is no way to remove a bookmark through the API. Today the only way to delete a bookmark is through the website UI.

Request

Add a delete route for bookmarks, e.g.:

DELETE /apiv2/me/bookmarks/<bookmark_id>/

It should require OAuth2 with the same scope as bookmark creation, and operate only on the authenticated user's own bookmarks. Ideally, it'd be a 204 No Content on success and 404 if no matching bookmark exists would mirror typical REST conventions.

Motivation

Bookmarking is inherently a two-way operation. Any client that exposes "bookmark" naturally needs "unbookmark." Without a delete route, apps built on the API have to either send users to the website to manage their own bookmarks, which can be annoying/frustrating for accidental bookmarkings. Create + read + delete would make the bookmark surface self-contained for API consumers.

Happy to test against a candidate endpoint!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions