Update notification

PUT /data/user/notifications/{notification_id}
Jwt authorization

Change the read status of a specific notification. Only the notification owner can update their notifications.

Path parameters

  • notification_id string(uuid) Required

    Notification unique identifier

application/json

Body Required

  • read boolean

    Mark notification as read or unread

Responses

  • 200 application/json

    Notification updated successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Notification unique identifier

    • type string

      Notification type

    • read boolean

      Whether notification is read

    • author_id string(uuid)

      Author person identifier

    • comment_id string(uuid)

      Comment identifier

    • task_id string(uuid)

      Task identifier

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Last update timestamp
PUT /data/user/notifications/{notification_id} 
curl \
 --request PUT 'http://api.example.com/data/user/notifications/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"read":true}'
Request examples 
{
  "read": true
}
Response examples (200) 
{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "type": "comment",
  "read": true,
  "author_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "comment_id": "d57d9hd7-fh08-7998-d403-80786315f58",
  "task_id": "e68e0ie8-gi19-8009-e514-91897426g69",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}