Deals

Remove a deal bookmark

DELETE/deals/{deal_id}/bookmark
bookmarks:writedelete_deal_bookmarkDestructiveIdempotent

Removes the token's acting user's bookmark from the deal and returns 204, also when the deal was not bookmarked. Only the acting user's bookmark: a user_id in the query returns 422 missing. An unknown deal, or one the token can't see, returns 404. dry_run shows the result without saving it. Emits deal.unbookmarked, with the acting user as the actor, only when a bookmark was removed; it also queues the platform's favourite event to the event queue. Sends no email. PUT /deals/{deal_id}/bookmark undoes it.

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

204

The deal is not bookmarked by the acting user.

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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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