v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
AlertPresets

Update an Alert Preset

Update an alert preset within the specified account.

put/public/v3/AlertPresets/{alertPresetId}

Path parameters

alertPresetIdinteger required

ID of the alert preset.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Request body

namestring required

The unique name of your alert preset.

descriptionstring nullable

A description of what the alert preset is used for.

assigneesstring[] nullable

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

notifyWhenActiveboolean

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

notifyAllCollaboratorsboolean

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

The alert preset has been updated