githubEdit

delete__systemevent_read

DELETE /systemevent/read

Mark System Event(s) as Unread

Marks one or more system events as unread for the current authenticated user by removing the read records. Send a single id or an array ids in the request body. Used to allow users to “mark as unread” in notification UIs. The operation is idempotent: deleting an already-unread event still returns success.

Key Features:

  • Removes server-side read state for the current user and the given event(s)

  • Supports a single event id or multiple ids in one request

  • Idempotent: calling again when the event is already unread still returns success

  • Used by notification UIs to support “Mark as unread”

Authentication:

  • Requires valid Bearer token authentication

  • User can only remove their own read state (no cross-user scope)

Request Body: JSON with either id (number) or ids (array of numbers). At least one valid integer id is required.

TypeScript Client Library

// Single id or array of ids
public markSystemEventAsUnread = async (systemEventLogId: number | number[]): Promise<SystemEventReadStatusResponse> => {
  const body = Array.isArray(systemEventLogId) ? { ids: systemEventLogId } : { id: systemEventLogId };
  return this.makeRequest<SystemEventReadStatusResponse>('systemevent/read', 'DELETE', body);
};

Code Samples

Parameters

Name
In
Type
Required
Description

id

body

number

false

Single system event log ID to mark as unread (use id or ids)

ids

body

number[]

false

Array of system event log IDs to mark as unread (use id or ids)

Provide either id or ids; at least one valid integer id is required.

Example responses

200 Response

400 Response

401 Response

500 Response

Responses

Status
Meaning
Description
Schema

200

Event(s) marked as unread successfully

Inline

400

Missing or invalid id or ids

Inline

401

Authentication required or user not found

Inline

500

Internal server error

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

true

none

Whether the operation succeeded

Status Code 400, 401, 500

Name
Type
Required
Restrictions
Description

» error

string

true

none

Error message

This operation requires authentication via Bearer token.

Last updated

Was this helpful?