Skip to main content
PUT
/
sensor_link
/
pause
/
deliveries
Pause sensors by deliveries
curl --request PUT \
  --url https://api.truecold.io/sensor_link/pause/deliveries \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "sensor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shipment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "handling_unit_history_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pending_upload_data": true,
  "zone_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": "HANDLING_UNIT"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Contact your administrator to get an API key.

Body

application/json

IDs of entities (deliveries, shipments, handling units, or sensors) to pause, resume, or stop

​
ids
string<uuid>[]
required

Array of entity IDs

Response

Successfully updated sensor_link

Sensor_link entity (API response)

​
id
string<uuid>

Unique identifier

​
created_at
string<date-time>

Creation timestamp

​
sensor_id
string<uuid>

Sensor ID

​
delivery_id
string<uuid>

Delivery ID

​
shipment_id
string<uuid>

Shipment ID

​
status
string

Status

​
updated_at
string<date-time>

Last update timestamp

​
handling_unit_history_id
string<uuid>

Handling unit_history ID

​
pending_upload_data
boolean

Pending Upload Data

​
zone_id
string<uuid> | null

Zone ID

​
scope
enum<string>
default:HANDLING_UNIT

Sensor link scope

Available options:
DELIVERY,
SHIPMENT,
HANDLING_UNIT,
ZONE