post__systemevent_read
POST /systemevent/read
Mark System Event(s) as Read
Marks one or more system events as read for the current authenticated user. Send a single id or an array ids in the request body. Used to track which notifications the user has seen. Events must belong to the same organization as the user; events in other orgs are ignored.
Key Features:
Persists read state per user and per event (server-side)
Supports a single event id or multiple ids in one request
Idempotent: calling again for an already-read event still returns success
Used by notification UIs (e.g. bell icon) to clear unread state
Authentication:
Requires valid Bearer token authentication
User must be associated with an organization
Only events in the user’s organization are marked as read; others are skipped
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 markSystemEventAsRead = async (systemEventLogId: number | number[]): Promise<SystemEventReadStatusResponse> => {
const body = Array.isArray(systemEventLogId) ? { ids: systemEventLogId } : { id: systemEventLogId };
return this.makeRequest<SystemEventReadStatusResponse>('systemevent/read', 'POST', body);
};Code Samples
Parameters
id
body
number
false
Single system event log ID to mark as read (use id or ids)
ids
body
number[]
false
Array of system event log IDs to mark as read (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
403 Response
500 Response
Responses
Response Schema
Status Code 200
» success
boolean
true
none
Whether the operation succeeded
Status Code 400, 401, 403, 500
» error
string
true
none
Error message
This operation requires authentication via Bearer token. Only events in the user’s organization are marked as read; other ids are ignored.
Last updated
Was this helpful?