Notifications

Mark notification read

Changed on

Mark one notification as read. Only the current user's notifications with current resource read permission and API key scope are accessible.

patch/notification/{id}/read

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/notification/{id}/read
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

The updated notification

idstring required
userIdstring required
titlestring nullable required
contentstring nullable required

Free-text body. Null for generated notifications, whose text the client renders from type and eventData.

typestring required

One of: info, task_created, workspace_created, task_status_changed, task_assignee_changed, time_entry_created, due_date_reminder, task_overdue, task_mention, task_comment.

eventDataunknown
isReadboolean nullable required
resourceIdstring nullable required

The id of the task or workspace the notification points at.

resourceTypestring nullable required

task or workspace.

createdAtstring date-time required
updatedAtstring date-time required

Changes

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 2ed51b8af657Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the non-success response with the status