v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

Update alert status

Update the resolution status of an alert.

Alert Status: Accepts AlertResolutionStatus enum: 'NotStarted' (0), 'InProgress' (1), or 'Resolved' (2). Note: 'AutoResolved' (3) is system-managed only and cannot be set via API.

put/public/v3/Shipments/{shipmentId}/alerts/{alertId}/status

Path parameters

shipmentIdstring required

shipmentId of the shipment.

alertIdstring required

ID of the alert to update.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Request body

status0 | 1 | 2 | 3

Response

Alert status updated successfully