Sign in

v1

latestOpenAPI 3.0.32026-07-23273969.2 KB
Mismatch alerts

Update a mismatch observation

Partial update of USDOT (usdot), MC (mc), logos, display name (alert_name), and/or is_disabled. Send at least one field. Requires permission external-api-mismatch-observations or admin. Only alerts belonging to the JWT customer_id can be updated; otherwise 403. logos values are normalized to lowercase before persistence and response. Logo matching remains case-insensitive. Returns the full updated observation (same shape as list items).

patch/mismatch-observations/{observation_id}

Path parameters

observation_idstring uuid required

Mismatch observation (alert) identifier.

Request body

usdotstring nullable

New USDOT value; null clears when paired with MC update rules.

mcstring nullable

New MC value; null clears when paired with USDOT update rules.

logosstring[] nullable

Trailer logos list. Values are trimmed, deduplicated, and stored/returned in lowercase format. Matching against the logos catalog.

alert_namestring nullable

Display name; blank or whitespace-only is stored as null.

is_disabledboolean

Whether the observation is disabled.

Response

Full updated mismatch observation.

idstring uuid required

Alert row identifier.

alert_namestring nullable

Optional display name; may be null if not set.

usdotstring nullable required

USDOT value from stored criteria.

mcstring nullable required

MC value from stored criteria.

logosstring[]

Trailer logos from logos, returned in normalized lowercase format. Empty when not configured.

is_disabledboolean required

Whether this mismatch observation alert is disabled.

created_atstring date-time nullable

Creation timestamp when available.

last_run_atstring date-time nullable

Last run timestamp in ISO-8601 format; null when not run yet.