Skip to main content
PUT
/
api
/
v2
/
alerts
/
{id}
/
{date}
/
update-read-status
Update alert read status (V2)
curl --request PUT \
  --url https://api.telemax.com.au/api/v2/alerts/{id}/{date}/update-read-status \
  --header 'Authorization: Bearer <token>'
{}

Overview

Sets the read/unread state of a single alert record identified by its alert definition ID and trigger timestamp.
This endpoint replaces V1 Mark alert read. Note: V1 always marks as read regardless of the isRead parameter; V2 correctly honours the read/unread state.
Rate limit: 60 requests per 60 seconds per token.

Endpoint

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

Path parameters

id
integer
required
Alert definition ID (AlertDto.Id).
date
string (datetime)
required
Trigger timestamp of the alert record (AlertDto.UtcTime), ISO 8601.

Query parameters

isRead
boolean
required
true to mark as read; false to mark as unread.

Response

200 OK — empty body on success.

Error responses

StatusMeaning
401Token does not have access to this alert
404Alert record not found
curl -X PUT "https://api.telemax.com.au/api/v2/alerts/101/2026-04-27T14:30:00/update-read-status?isRead=true" \
  -H "Authorization: Bearer <token>"

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from POST /api/v2/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 to the company the key belongs to and may restrict access to a vehicle allowlist and/or action set (see token claims).

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

Path Parameters

id
integer
required

Alert definition ID.

date
string
required

Trigger timestamp of the alert record (ISO 8601).

Query Parameters

isRead
boolean

Response

200 OK — Empty body. Alert read status updated.