Skip to main content
PUT
/
alert
/
{id}
Update alert
curl --request PUT \
  --url https://api.truecold.io/alert/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "<string>",
  "message": "<string>",
  "entity_type": "<string>",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "triggered_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "handling_unit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "min_temp": 123,
  "max_temp": 123,
  "excursion_minutes": 123,
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shipment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sites_id": [
    "<string>"
  ],
  "code": "<string>",
  "status": "<string>",
  "trigger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier_code": "<string>",
  "receiver_code": "<string>",
  "transport_mode": "<string>",
  "type": "<string>",
  "allowance_minutes": 123,
  "max_temp_allowed": 123,
  "min_temp_allowed": 123
}

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 creation/update

​
status
string

Alert status (PENDING, ACKNOWLEDGED, RESOLVED)

​
message
string

Alert message

​
entity_type
string

Type of entity that triggered the alert

​
entity_id
string<uuid>

ID of the entity that triggered the alert

​
triggered_at
string<date-time>

When the alert was triggered

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