---
title: "Create an Alert Preset"
method: POST
path: "/public/v3/AlertPresets"
tags: ["AlertPresets"]
---

# Create an Alert Preset

`POST /public/v3/AlertPresets`

Create a new alert preset within the specified account.

## Headers

- `x-tive-account-id` integer, required

## Request body

- AlertPresetRequest
  - `name` string, required — The unique name of your alert preset.
  - `description` string, nullable — A description of what the alert preset is used for.
  - `assignees` string[], nullable — A list of user IDs indicating who will be notified of the alert preset alerts.
  - `temperatureTriggers` TemperatureTriggerRequest[], nullable — Temperature based alert triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
    - `triggerValue` number, float, required — The threshold value you want to be alerted of (e.g. 25.5°C)
    - `triggerUnit` string, required — The unit of the trigger value. Values can be `F` (Fahrenheit) or `C` (Celsius).
    - `intervalDelay` integer, required — Indicates the amount of time that an alert should be delayed.
    - `intervalDelayUnit` string, required — The unit used when specifying the amount of time that an alert should be delayed. Values can be `minutes`, `hours`, `days`, or `weeks`. The maximum time cannot exceed 2 weeks.
  - `percentTriggers` PercentTriggerRequest[], nullable — Percent based alert triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
    - `triggerValue` integer, required — The threshold value you want to be alerted of.
    - `triggerUnit` string, required — Value must be %.
  - `arriveDepartTriggers` ArriveDepartTriggerRequest[], nullable — Immediate arrival and departure based alert triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
    - `alertOn` string, required — Specify when the alert should trigger. Values include `Arrival` or `Departure`.
  - `intervalTriggers` IntervalTriggerRequest[], nullable — Interval delay based alert triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
    - `intervalDelay` integer, required — Indicates the amount of time that an alert should be delayed.
    - `intervalDelayUnit` string, required — The unit used when specifying the amount of time that an alert should be delayed. Values can be minutes, hours, days, or weeks. The maximum time cannot exceed 2 weeks. Note, only type `Connectivity` can use `minutes` for interval triggers.
  - `shockLightTriggers` ShockLightTriggerRequest[], nullable — Shock and light based alert triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
    - `triggerValue` integer, nullable — Optional: The threshold value you want to be alerted of
    - `triggerUnit` string, nullable — Optional: The unit of the trigger value. Must be G or LUX
  - `geofenceTriggers` GeofenceTriggerRequest[], nullable — Simple radius Geofence triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
    - `locationId` integer, required — The id of the location for the geofence.
    - `alertOn` string, required — Specify when the alert should trigger. Values include `Inside` or `Outside`.
  - `shipmentInboundTriggers` ShipmentInboundTriggerRequest[], nullable — Shipment inbound triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
    - `triggerValue` number, double, required — The distance from the destination at which you want to be alerted
    - `triggerUnit` string, required — The unit of the trigger value. Values can be `Kilometers` or `Miles`
  - `booleanTriggers` TriggerRequestBase[], nullable — Simple true/false based alert triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
  - `routeDeviationTriggers` RouteDeviationTriggerRequest[], nullable — Route deviation triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
  - `tiltTriggers` TiltTriggerRequest[], nullable — Tilt angle alert triggers. Click <a href="https://developers.tive.com/docs/triggers">here</a> for more documentation on triggers.
    - `type` string, required — The type of alert trigger you wish to specify. See more <a href="https://developers.tive.com/docs/triggers">here</a> for valid values.
    - `isActiveAtOrigin` boolean, required — Only triggers alerts from the shipment origin address. Note, at least one of the isActive fields must be set to true.
    - `isActiveInTransit` boolean, required — Only triggers alerts if the shipment is in transit. Note, at least one of the isActive fields must be set to true.
    - `isActiveAtDestination` boolean, required — Only triggers alerts from the shipment destination address. Note, at least one of the isActive fields must be set to true.
    - `triggerValue` number, float, required — The threshold value you want to be alerted of (e.g. 15°)
    - `triggerUnit` string, required — Value must be °.
    - `alertOnRecovery` boolean, nullable — If True, send an alert when tilt returns to acceptable range. Default: false
  - `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.

## Response `201`

The created alert preset id

- integer

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/tive/apis/tive-public-api.md) · [All operations](https://skmtc.net/tive/apis/tive-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tive/tive-public-api/revisions/9a8d869e3cdc/schema)