Skip to main content
POST
/
api
/
SetAlertAsRead
Mark Alert as Read
curl --request POST \
  --url https://api.telemax.com.au/api/SetAlertAsRead \
  --header 'Authorization: Bearer <token>'
{}

Overview

Marks a specific alert record (alert id + exact UTC timestamp) as read.
⚠️ Note: The implementation always sets MarkedAsReadDate to DateTime.UtcNow and does not branch on isRead—the query parameter is effectively ignored.
A V2 version of this endpoint is available: Update alert read status. New integrations should prefer V2.

Endpoint

POST /api/SetAlertAsRead

Query parameters

alertId
integer
required
Alert id.
date
string (datetime)
required
Exact UTC timestamp of the alert occurrence row.
isRead
boolean
required
Intended read flag (not applied in current code).

Response

200 OK empty body.

Error responses

StatusMeaning
404Alert not found or no access

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from POST /api/authentication/token/user or POST /api/authentication/token/api-key.

Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.

Scoping:

  • User tokens are scoped to a single company.
  • API key tokens may restrict access to a vehicle allowlist and/or action set (see token claims).

No refresh endpoint — re-authenticate with your credentials when the token expires.

Headers

Content-Type
string

Standard and must keep as it is.

Authorization
string
required

Bearer your_token

Query Parameters

alertId
integer
required

Alert ID

date
string
required

Alert date.

isRead
boolean
required

Response

Successful response

The response is of type object.