v1

latestOpenAPI 3.0.32026-07-23273969.2 KB
alerts

External Patch Alert

Partially update an existing alert by alert_id. start_date and end_date accept ISO 8601 date-time strings with Z, timezone offsets, or no timezone. Timezone-aware values are normalized to UTC and returned without timezone information.

patch/alerts/{alert_id}

Path parameters

alert_idinteger required

Request body

alert_namestring
location_statestring
location_citystring
license_platestring
license_plate_statestring
usdot_numberstring
chassis_numberstring
exact_match_chassis_numberboolean
container_numberstring
equipment_typestring
exact_match_container_numberboolean
mc_numberstring
vinstring
cab_numberstring
trailer_logostring
trailer_numberstring
disabledboolean
cc_emailsstring[]
alert_typestring
exact_match_trailer_numberboolean
start_datestring date-time

ISO 8601 date-time. Values with Z or timezone offsets are normalized to UTC and stored/returned without timezone information.

end_datestring date-time

ISO 8601 date-time. Values with Z or timezone offsets are normalized to UTC and stored/returned without timezone information.

deep_searchstring
notification_channelsstring[]

Response

Successful Response

alert_namestring required
location_statestring
location_citystring
license_platestring
license_plate_statestring
usdot_numberstring
chassis_numberstring
exact_match_chassis_numberboolean
container_numberstring
equipment_typestring
exact_match_container_numberboolean
mc_numberstring
vinstring
cab_numberstring
trailer_logostring
trailer_numberstring
disabledboolean
cc_emailsstring[]
alert_typestring
exact_match_trailer_numberboolean
start_datestring date-time

Returned as a timezone-free UTC date-time string after normalization.

end_datestring date-time

Returned as a timezone-free UTC date-time string after normalization.

deep_searchstring
idinteger required
emailstring required
last_updated_timestampstring date-time required
insert_timestampstring date-time required
notification_channelsstring[]