Deal Feedback

Mark the feedback on a deal as read

POST/deals/{deal_id}/feedback/actions/mark-read

Marks the deal's unread feedback as read, or only the items in ids, and returns how many changed in affected. The flag is shared, so one call marks it for every user; items already read keep their first reader. Ids of other deals are ignored. A user_id returns 422 missing. Calling again returns 200 with affected: 0. Sends no email and emits no webhook. It can't be undone.

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.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, optional · DealFeedbackMarkRead

  • idsstring (uuid)[]#

    The feedback to mark read. Omit it to mark every unread item of the deal; ids that are not feedback of this deal are ignored.

{
  "ids": [
    "7a8b9c0d-1e2f-4a3b-8c5d-6e7f80910213"
  ]
}

Responses

200

The number of items marked read.

DealFeedbackMarkReadResult
{
  "data": {
    "affected": 3
  }
}
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 POST https://your-org-domain/kong/core/api/v2/deals/{deal_id}/feedback/actions/mark-read\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "ids": [
    "7a8b9c0d-1e2f-4a3b-8c5d-6e7f80910213"
  ]
}'