Skip to main content
PUT
Update alert read status (V2)

Overview

Sets the read/unread state of one alert record, identified by its alert definition ID and its exact trigger time. The alert definition must belong to one of the token’s companies (its own company or a direct sub-company that is not cancelled).
This endpoint replaces V1 Mark alert read. V1 always marks as read regardless of isRead. V2 applies isRead, but defaults to unread when it is omitted, and returns 200 even when no record matched.
Rate limit: 10 req/s · 60/min · 6,000/hr · 144,000/day

Endpoint

PUT /v2/api/alerts/{id}/{date}/update-read-status

Path parameters

integer
required
Alert definition ID: the record’s id in Alert records.
string (datetime)
required
The record’s trigger time in UTC: its utcTime (a trailing Z is optional). Matched exactly, to the fraction of a second.

Query parameters

boolean
default:"false"
true marks the record read, false marks it unread. Optional: omitting it marks the record unread.
Some records cannot be addressed; the call then returns 200 and changes nothing:
  • records stored with fractional seconds (a small share), because utcTime is served without them;
  • records written before the alert’s type was edited.
When several records of one alert share the exact time (two vehicles, or one per geofence), one of them is marked, and which one is arbitrary. A repeat call probably hits the same record, so the others may only clear through Mark all alerts read.

Response

200 OK — empty body. Also returned when no record matched {id} and {date}, so a 200 does not confirm that anything changed. The read flag is shared with the Telemax Dashboard.

Error responses

Authorizations

Authorization
string
header
required

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

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

Scoping: API key tokens are scoped by the key's company and its action set; see Token scoping.

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

Path Parameters

id
integer
required

Alert definition ID: the record's id in Alert records.

date
string
required

The record's trigger time in UTC (its utcTime), matched exactly to the fraction of a second. utcTime is served without fractional seconds, so a record stored with them cannot be addressed from it.

Query Parameters

isRead
boolean
default:false

true marks the record read, false unread. Optional: omitting it marks the record unread.

Response

200 OK — Empty body. Also returned when no record matched, so it does not confirm a change.