Skip to main content
PUT
Update alert

Authorizations

x-api-key
string
header
required

API key for authentication. Contact your administrator to get an API key.

Path Parameters

id
string
required

Alert ID

Body

application/json

Alert input data for update

status
enum<string>
required

New alert status

Available options:
OPEN,
IN_PROGRESS,
DONE,
INVALID

Response

Successfully updated alert

Alert entity (API response)

id
string<uuid>

Unique identifier

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

handling_unit_id
string<uuid>

Handling unit ID

min_temp
number

Min Temp

max_temp
number

Max Temp

excursion_minutes
integer

Excursion Minutes

account_id
string<uuid>

Account ID

owner_id
string<uuid>

Owner ID

delivery_id
string<uuid>

Delivery ID

shipment_id
string<uuid>

Shipment ID

sites_id
string[]

Sites ID

code
string

code code

status
string

Status

trigger_id
string<uuid>

Trigger ID

carrier_code
string

carrier code

receiver_code
string

receiver code

transport_mode
string

Transport Mode

type
string

Type

allowance_minutes
integer

Allowance Minutes

max_temp_allowed
number

Max Temp Allowed

min_temp_allowed
number

Min Temp Allowed

handling_unit_history_id
string<uuid> | null

Handling unit history ID

scope
enum<string> | null

Alert scope

Available options:
DELIVERY,
SHIPMENT,
HU_ZONE,
HU_DELIVERY,
ZONE
zone_id
string<uuid> | null

Zone ID

latitude
number | null

Latitude

longitude
number | null

Longitude

sensor_id
string<uuid> | null

Sensor ID

carrier_id
string<uuid> | null

Carrier ID

location_id
string<uuid> | null

Location ID

ai
boolean | null

AI-generated alert