Mark a notification group as read

cURL

curl "https://api.phrase.com/v2/notification_groups/:id/mark_as_read" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH \
  -H 'Content-Type: application/json'

{
  "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"
    }
  }
}

PATCH

notification_groups

{id}

mark_as_read

cURL

curl "https://api.phrase.com/v2/notification_groups/:id/mark_as_read" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH \
  -H 'Content-Type: application/json'

{
  "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"
    }
  }
}

Authorizations

Authorization

string

header

required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP

string

Two-Factor-Authentication token (optional)

Path Parameters

string

required

Response

string

event_name

string

created_at

string<date-time>

updated_at

string<date-time>

notifications_count

integer

latest_notification

notification · object

Show child attributes

latest_notification.id

string

latest_notification.event_name

string

latest_notification.created_at

string<date-time>

latest_notification.updated_at

string<date-time>

latest_notification.delivered_at

string<date-time>

latest_notification.seen_at

string<date-time>

latest_notification.data

object

latest_notification.resource

object

latest_notification.locale

locale · object

Show child attributes

latest_notification.locale.id

string

latest_notification.locale.name

string

latest_notification.locale.code

string

latest_notification.locale.default

boolean

latest_notification.locale.main

boolean

latest_notification.locale.rtl

boolean

latest_notification.locale.plural_forms

string[]

latest_notification.locale.ordinal_plural_forms

string[]

latest_notification.locale.source_locale

locale_preview · object

Show child attributes

latest_notification.locale.source_locale.id

string

latest_notification.locale.source_locale.name

string

latest_notification.locale.source_locale.code

string

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}

latest_notification.locale.fallback_locale

locale_preview · object

Show child attributes

latest_notification.locale.fallback_locale.id

string

latest_notification.locale.fallback_locale.name

string

latest_notification.locale.fallback_locale.code

string

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}

latest_notification.locale.created_at

string<date-time>

latest_notification.locale.updated_at

string<date-time>

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "de",
  "code": "de-DE",
  "default": true,
  "main": false,
  "rtl": false,
  "plural_forms": ["zero", "one", "other"],
  "ordinal_plural_forms": ["zero", "other"],
  "source_locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "en",
    "code": "en-GB"
  },
  "fallback_locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "en",
    "code": "en-GB"
  },
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}

latest_notification.user

user_preview · object

Show child attributes

latest_notification.user.id

string

latest_notification.user.username

string

latest_notification.user.name

string

latest_notification.user.gravatar_uid

string

Example:

null

latest_notification.project

project · object

Show child attributes

latest_notification.project.id

string

latest_notification.project.name

string

latest_notification.project.slug

string

latest_notification.project.main_format

string

latest_notification.project.project_image_url

string

latest_notification.project.media

string

latest_notification.project.account

account · object

Show child attributes

latest_notification.project.account.id

string

latest_notification.project.account.name

string

latest_notification.project.account.slug

string

latest_notification.project.account.company

string

latest_notification.project.account.created_at

string<date-time>

latest_notification.project.account.updated_at

string<date-time>

latest_notification.project.account.company_logo_url

string

Example:

{
  "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"
}

latest_notification.project.space

space · object

Show child attributes

latest_notification.project.space.id

string

latest_notification.project.space.name

string

latest_notification.project.space.created_at

string<date-time>

latest_notification.project.space.updated_at

string<date-time>

latest_notification.project.space.projects_count

integer

Example:

{
  "id": "2e7574e8f2372906a03110c2a7cfe671",
  "name": "My first space",
  "created_at": "2020-02-25T12:17:25Z",
  "updated_at": "2020-03-13T14:46:57Z",
  "projects_count": 2
}

latest_notification.project.point_of_contact

user_preview · object

Show child attributes

latest_notification.project.point_of_contact.id

string

latest_notification.project.point_of_contact.username

string

latest_notification.project.point_of_contact.name

string

latest_notification.project.point_of_contact.gravatar_uid

string

Example:

null

latest_notification.project.created_at

string<date-time>

latest_notification.project.updated_at

string<date-time>

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "slug": "android_project",
  "main_format": "xml",
  "project_image_url": "http://assets.example.com/project.png",
  "account": "account",
  "space": "space",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}

latest_notification.account

account · object

Show child attributes

latest_notification.account.id

string

latest_notification.account.name

string

latest_notification.account.slug

string

latest_notification.account.company

string

latest_notification.account.created_at

string<date-time>

latest_notification.account.updated_at

string<date-time>

latest_notification.account.company_logo_url

string

Example:

{
  "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"
}

latest_notification.group

notification_group · object

Show child attributes

latest_notification.group.id

string

latest_notification.group.event_name

string

latest_notification.group.created_at

string<date-time>

latest_notification.group.updated_at

string<date-time>

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "event_name": "keys:create",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}

Example:

{
  "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"
  }
}

Mark all notification groups as read List notifications

⌘I

Guides

API Documentation

Authorizations

Headers

Path Parameters

Response