Sign in
Notifications

Mark notification read

Mark one notification as read. Scoped to the current user, so another user's notification is not found.

patch/notification/{id}/read

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.

{"stackTrail":"components:schemas:Notification:properties:eventData","oasType":"schema","type":"unknown","description":"Type-specific payload, e.g. { taskTitle, oldStatus, newStatus, projectId, workspaceId }."}
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