Update notification

PUT /data/notifications/{instance_id}

Update a notification with data provided in the request body. JSON format is expected.

Path parameters

  • instance_id string(uuid) Required
application/json

Body Required

  • read boolean

Responses

  • 200 application/json

    Notification updated successfully

    Hide response attributes Show response attributes object
    • id string(uuid)
    • person_id string(uuid)
    • comment_id string(uuid)
    • read boolean
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    Invalid data format or validation error

PUT /data/notifications/{instance_id}
curl \
 --request PUT 'http://api.example.com/data/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": "a24a6ea4-ce75-4665-a070-57453082c25",
  "person_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "comment_id": "c24a6ea4-ce75-4665-a070-57453082c25",
  "read": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}