Skip to main content
PUT
Mark all alerts read (V2)

Overview

Marks alert records belonging to the specified company as read. By default — when no date range is supplied — alerts from the last 30 days are marked as read. Supply an optional startDate/endDate range to target a specific window instead. The range must not exceed 31 days.
The V1 version of this endpoint is Mark all alerts read.
Rate limit: 4 req/s · 20/min · 600/hr · 14,400/day

Endpoint

PUT /v2/api/companies/{id}/set-all-alerts-read

Path parameters

integer
required
Company ID.

Query parameters

string
Start of the date range (inclusive), ISO 8601. Optional, but must be provided together with endDate. When both are omitted, alerts from the last 30 days are marked as read.
string
End of the date range (inclusive), ISO 8601. Optional, but must be provided together with startDate. The range from startDate to endDate cannot exceed 31 days.

Response

200 OK — empty body on success.

Error responses

A 422 Unprocessable Entity is returned when the date range is invalid:

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 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

Query Parameters

startDate
string<date-time>

Start of the date range (inclusive). Optional, but must be provided together with endDate. When omitted, alerts from the last 30 days are marked as read.

endDate
string<date-time>

End of the date range (inclusive). Optional, but must be provided together with startDate. The range from startDate to endDate cannot exceed 31 days.

Response

200 OK — Empty body. All alert records marked as read.