notification

Mark notification threads as read, pinned or unread on a specific repo

put/repos/{owner}/{repo}/notifications

Request

  • Base URL
    https://demo.gitea.com/api/v1
  • Auth
    • HTTP basic
    • or API key in query parameter token
    • or API key in query parameter access_token
    • or API key in header Authorization
    • or API key in query parameter sudo
    • or API key in header Sudo
    • or API key in header X-GITEA-OTP
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

ownerstring required

owner of the repo

repostring required

name of the repo

Query parameters

allstring

If true, mark all notifications on this repo. Default value is false

status-typesstring[]

Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.

to-statusstring

Status to mark notifications as. Defaults to read.

last_read_atstring date-time

Describes the last point that notifications were checked. Anything updated since this time will not be updated.

Response

NotificationThreadList

idinteger

ID is the unique identifier for the notification thread

pinnedboolean

Pinned indicates if the notification is pinned

unreadboolean

Unread indicates if the notification has been read

updated_atstring date-time

UpdatedAt is the time when the notification was last updated

urlstring

URL is the API URL for this notification thread

Example response

[
  {
    "repository": {
      "repo_transfer": {
        "teams": [
          {
            "units": [
              "repo.code",
              "repo.issues",
              "repo.ext_issues",
              "repo.wiki",
              "repo.pulls",
              "repo.releases",
              "repo.projects",
              "repo.ext_wiki"
            ],
            "units_map": {
              "repo.code": "read",
              "repo.ext_issues": "none",
              "repo.ext_wiki": "none",
              "repo.issues": "write",
              "repo.projects": "none",
              "repo.pulls": "owner",
              "repo.releases": "none",
              "repo.wiki": "admin"
            }
          }
        ]
      }
    }
  }
]

Changes

No recorded changes to this operation across all 13 revisions of this API.