Deals

Bookmark a deal

PUT/deals/{deal_id}/bookmark
bookmarks:writereplace_deal_bookmarkDestructiveIdempotent

Bookmarks the deal for the token's acting user and returns the bookmark. It takes no body: any body field returns 422 prohibited, and a user_id in the query or body returns 422 missing. Repeating it returns 200 and changes nothing. dry_run shows the result without saving. Emits deal.bookmarked (actor: the acting user) only when the bookmark is new; sends no email. DELETE undoes it. Read bookmarks with GET /deals?filter[bookmarked]=true or include=bookmarked.

Path parameters

  • deal_idstring (uuid)Required#

    The deal's id, a uuid. An unknown deal, or one the token can't see, returns 404.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Responses

200

The bookmark.

DealBookmark
{
  "data": {
    "deal_id": "5f0c7a52-3d8e-4b1a-9c47-8e2d6a1b3f90",
    "bookmarked": true,
    "created_at": "2026-11-09T09:30:00Z"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PUT https://your-org-domain/kong/core/api/v2/deals/{deal_id}/bookmark\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"