Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Notification Groups

Mark a notification group as read

Mark a notifications group of the current user as read

patch/notification_groups/{id}/mark_as_read

Path parameters

idstring required

ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

idstring
event_namestring
created_atstring date-time
updated_atstring date-time
notifications_countinteger

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "event_name": "keys:create",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "latest_notification": {
    "id": "abcd1234",
    "event_name": "keys:create",
    "data": "object notification data",
    "resource": "object of notification resource",
    "locale": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "de",
      "code": "de-DE",
      "default": true,
      "main": false,
      "rtl": false,
      "plural_forms": [
        "zero",
        "one",
        "other"
      ],
      "source_locale": {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "name": "en",
        "code": "en-GB"
      },
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    },
    "user": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "username": "joe.doe",
      "name": "Joe Doe"
    },
    "project": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "My Android Project",
      "main_format": "xml",
      "project_image_url": "http://assets.example.com/project.png",
      "account": {
        "id": "abcd1234",
        "name": "Company Account",
        "slug": "company_account",
        "company": "My Awesome Company",
        "created_at": "2015-01-28T09:52:53Z",
        "updated_at": "2015-01-28T09:52:53Z",
        "company_logo_url": "http://assets.example.com/company_logo.png"
      },
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    },
    "account": {
      "id": "abcd1234",
      "name": "Company Account",
      "slug": "company_account",
      "company": "My Awesome Company",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z",
      "company_logo_url": "http://assets.example.com/company_logo.png"
    },
    "group": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "event_name": "keys:create",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    }
  }
}