Update an Alert Preset

put

https://api.tive.com/public/v3/AlertPresets/{alertPresetId}

Update an alert preset within the specified account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

alertPresetId

int32

required

ID of the alert preset.

Body Params

name

string

required

length ≥ 1

The unique name of your alert preset.

description

string | null

A description of what the alert preset is used for.

assignees

array of strings | null

A list of user IDs indicating who will be notified of the alert preset alerts.

assignees

temperatureTriggers

array of objects | null

Temperature based alert triggers. Click here for more documentation on triggers.

temperatureTriggers

percentTriggers

array of objects | null

Percent based alert triggers. Click here for more documentation on triggers.

percentTriggers

arriveDepartTriggers

array of objects | null

Immediate arrival and departure based alert triggers. Click here for more documentation on triggers.

arriveDepartTriggers

intervalTriggers

array of objects | null

Interval delay based alert triggers. Click here for more documentation on triggers.

intervalTriggers

shockLightTriggers

array of objects | null

Shock and light based alert triggers. Click here for more documentation on triggers.

shockLightTriggers

geofenceTriggers

array of objects | null

Simple radius Geofence triggers. Click here for more documentation on triggers.

geofenceTriggers

shipmentInboundTriggers

array of objects | null

Shipment inbound triggers. Click here for more documentation on triggers.

shipmentInboundTriggers

booleanTriggers

array of objects | null

Simple true/false based alert triggers. Click here for more documentation on triggers.

booleanTriggers

routeDeviationTriggers

array of objects | null

Route deviation triggers. Click here for more documentation on triggers.

routeDeviationTriggers

tiltTriggers

array of objects | null

Tilt angle alert triggers. Click here for more documentation on triggers.

tiltTriggers

notifyWhenActive

boolean

Sends an alert notification for every measurement the alert remains active. Defaults to false if not specified.

notifyAllCollaborators

boolean

Automatically notify all shipment collaborators when an alert condition is met for a device on an active shipment. Defaults to false when not specified.

Headers

x-tive-account-id

int32

required

ID of the account the request will be made in.

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

The alert preset has been updated

400

The requested alert preset is not available

401

Unauthorized