Skip to content
Plune Plune Plune Docs

Mark one notification as read

POST
/v1/notifications/{id}/read
 
curl --request POST \
  --url https://beta-api.plune.ai/v1/notifications/example/read \
  --header 'Authorization: Bearer <token>'

Yours only, in the project the request runs in (#1063). Marking one that is already read changes nothing and answers 200 with its first readAt. Someone else’s notification, one of another project and an invented id are the same 404. Not an audit entry: it is the person’s own state. A reader is refused at the boundary with 403 read-only member.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

Section titled “Header Parameters ”
X-Plune-Project
string

Which of your projects to act in — an id from GET /v1/projects. Absent, your default project. A project you are not a member of answers 404, the same as one that does not exist. Ignored under a bearer token, which is bound to the project it was minted in.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The notification, read

Media type application/json

One thing told to one person in one project. The text is not stored finished: the dashboard words it from textKey and params in the person’s language. kind is from a closed list - for a bug (ADR 0057, #1067) bug.can_be_closed, bug.auto_closed, bug.reopened_by_regression and bug.fails_again (a case failed after the bug was closed by hand; it stays closed); a client shows an unknown kind by its textKey and does not fail.

object
id
required
string format: uuid
projectId
required
string
kind
required
string
Allowed values: bug.can_be_closed review.merged bug.auto_closed bug.reopened_by_regression bug.fails_again
entity
required

What it is about: the link the list opens.

object
kind
required
string
Allowed values: bug review_item
id
required
string
textKey
required

The dashboard dictionary entry that words it.

string
<= 120 characters
params
required

Flat values for the text; at most 2048 bytes as JSON.

object
key
additional properties
One of:
string
createdAt
required
string format: date-time
readAt
required

Null while unread.

string format: date-time
nullable
Example 
{
  "kind": "bug.can_be_closed",
  "entity": {
    "kind": "bug"
  }
}

401

Section titled “401 ”

No / invalid token or session

403

Section titled “403 ”

read-only member of the project

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

404

Section titled “404 ”

No such notification of yours in this project

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

429

Section titled “429 ”

Rate limit exceeded (120 a minute)