github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/notification_groups/mark_as_read.yaml (about)

     1  ---
     2  summary: Mark a notification group as read
     3  description: Mark a notifications group of the current user as read
     4  operationId: notification_groups/mark_as_read
     5  tags:
     6  - Notification Groups
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/id"
    10  responses:
    11    '200':
    12      description: OK
    13      content:
    14        application/json:
    15          schema:
    16            "$ref": "../../schemas/notification_group_detail.yaml#/notification_group_detail"
    17      headers:
    18        X-Rate-Limit-Limit:
    19          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    20        X-Rate-Limit-Remaining:
    21          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    22        X-Rate-Limit-Reset:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    24    '400':
    25      "$ref": "../../responses.yaml#/400"
    26    '404':
    27      "$ref": "../../responses.yaml#/404"
    28    '429':
    29      "$ref": "../../responses.yaml#/429"
    30  x-code-samples:
    31  - lang: Curl
    32    source: |-
    33      curl "https://api.phrase.com/v2/notification_groups/:id/mark_as_read" \
    34        -u USERNAME_OR_ACCESS_TOKEN \
    35        -X PATCH \
    36        -H 'Content-Type: application/json'
    37  - lang: CLI v2
    38    source: |-
    39      phrase notification_groups mark_as_read \
    40      --id <id> \
    41      --access_token <token>
    42  x-cli-version: '2.5'