PATCH
/
alerts
/
{id}
curl --request PATCH \
  --url https://api.truecold.io/v1/alerts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "code": "292",
  "status": "OPEN"
}'
{
  "error": false,
  "data": {
    "id": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "handling_unit_id": "<string>",
    "min_temp": 123,
    "max_temp": 123,
    "excursion_minutes": 123,
    "account_id": "<string>",
    "owner_id": "<string>",
    "delivery_id": "<string>",
    "shipment_id": "<string>",
    "code": 123,
    "status": "<string>",
    "trigger": "<string>",
    "temperature_range_id": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-api-key
string
required

API Key for authentication

Path Parameters

​
id
string
required

UUID of the alert

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

Body

application/json
​
code
number

The code of the alert

Example:

"292"

​
status
enum<string>

The status of the alert

Available options:
INVALID,
OPEN,
IN_PROGRESS,
DONE
Example:

"OPEN"

Response

200
application/json
​
error
boolean
Example:

false

​
data
object