Edit an Alert

This API allows you to edit an alert. You are allowed to edit alerts for those you have access to. Only one alert can be edited per API call. You need to pass the unique identifier of the alert in the Edit Alert API definition.

{
    "users": "",
    "cc": "",
    "alertMode": "2",
    "emailNotification": true,
    "webNotification": false,
    "mobileNotification": false,
    "soundNotification": false,
    "muted": false,
    "roleIds": null,
    "customAlertHours": 1,
    "emailAdmin": true,
    "emailDriver": false,
    "timeForSummary": 330,
    "alertName": "Standard VIN Change Alert",
    "alertTypeId": "42",
    "alertTypeData": {},
    "groupAlert": false,
    "vehicles": "47ec52ae-e02e-11ec-b6c5-bda8157dd221",
    "alertId": "21a48c90-5093-11ed-bc12-a9aeb8cc4208"
}

API Response Glossary

Field

Description

Data Type

generatedAtInMillis

Event performed timestamp in UTC milliseconds

Long

alertId

Unique identifier representing the alert

String

customerId

Unique identifier representing the customer

Long

alertType

Object representing the meta data of the alert type

AlertTypeVO

alertTypeId

Unique identifier representing the type of the alert

int

name

Name of the alert type

String

description

Brief description of the alert type

String

tableName

For Azuga Internal use

String

batchMessageTemplateKey

For Azuga Internal use

String

messageTemplateKey

For Azuga Internal use

String

createdAt

Created time of alert type in UTC milliseconds

Timestamp

deletedAt

Deleted time of alert type

Timestamp

deleted

Boolean value representing the alertType deletion(True=Deleted, False= Not Deleted)

boolean

eventTypeId

Unique identifier representing the event type

Integer

propertyKey

For Azuga Internal use

String

alertSubjectKey

For Azuga Internal use

String

dataSource

For Azuga Internal use

String

messageTemplate

For Azuga Internal use

String

packageId

For Azuga Internal use

int

cc

Email IDs configured in CC for the alert

String

mode

Frequency of the alert email.
1 - Indicates that the alert is triggered instaly
2 - Indicates that the alert is triggered as a summary alert.

Integer

messageTemplate

For Azuga Internal use

String

alertName

Name of the alert

String

createdAt

Alert creation time in UTC milliseconds

Timestamp

createdBy

Unique identifier of the user who created the alert

String

modifiedBy

Unique identifier of the user who updated the alert last

String

alertKeyValueMappingId

Unique identifier for mapping between the alert and the alertKey value

String

alertId

Unique identifier representing the alert

String

alertKey

Property of the alert

String

value

Corresponding value of the alertKey

String

formattedValue

For Azuga Internal use

String

groups

The comma-separated unique identifiers of group names that are associated with the alert. Vehicles under these groups are considered for the alert.

Set<AlertToGroupMappingVO>

alertToGroupMappingId

Unique identifier for mapping between the alert and the group.

String

groupId

Unique identifier representing the group

String

customerId

Unique identifier of the customer associated with the group

Long

createdBy

The unique identifier of the user who created the group

String

createdAt

Creation time of the group in UTC miliseconds

Timestamp

modifiedBy

The unique identifier of the user who modified the group last

String

modifiedAt

Last modified time of the group in UTC milliseconds

Timestamp

deleted

Boolean value representing the group deletion(True=Deleted, False= Not Deleted)

boolean

deletedAt

Deletion time of the group in UTC milliseconds

Timestamp

groupName

Name of the group

String

users

Object representing the meta data of the user

Set<AlertToUserIdMappingForMailVO>

alertToUserIdMappingForMailId

Unique identifier for mapping between the alert and the group.

String

userId

Unique identifier representing the user

String

createdBy

Unique identifier of the user who created the this user

String

createdAt

Creation time of the user in UTC milliseconds

Timestamp

modifiedBy

Unique identifier of the user who modified the user details last

String

modifiedAt

Last modified time of the user in UTC milliseconds

Timestamp

deleted

Boolean value representing the user deletion(True=Deleted, False= Not Deleted)

boolean

deletedAt

Deleted time of the user

Timestamp

deleted

Boolean value representing the alert deletion(True=Deleted, False= Not Deleted)

boolean

muted

Boolean value representing whether the alert is muted of not(True=Muted, False= Not Muted)

boolean

ruleSets

For Azuga Internal use

Set<RuleSetVO>

alertReminders

For Azuga Internal use

Set<AlertReminderVO>

vehicles

Array of vehicles with their details which are associated with the alert.

  • *alertId** - Unique Identifier of the alert
  • *vehicleId** - Unique Identifier of the vehicle
  • *createdAt** - Created time of vehicle
  • *name** - Name of the vehicle
  • *alertToTrackeeMappingId** - UniqueID representing the mapping between vehicle and alert

Set<AlertToTrackeeMappingVO>

alertId

Unique identifier representing the alert

String

vehicleId

Unique identifier representing the vehicle

String

createdAt

Creation time of the vehicles in UTC milliseconds

Timestamp

name

Name of the vehicle

String

alertToTrackeeMappingId

Unique identifier representing the mapping between the alert and vehicle

byte[]

assetSensors

For Azuga Internal use

Set<TemperatureSensorDTO>

defaultAlert

For Azuga Internal use

boolean

groupAlert

Boolean value representing whether the alert is a group alert or not
True = It is a group alert
False = It is not a group alert

boolean

alertTimeConfigs

This field gives you information about whether the alert is set to trigger only during a specific interval of time - Work Hours. The key field day=1 implies that it is Sunday. Similarly, 2 for Monday and 3 for Tuesday and so on.

Set<AlertTimeConfig>

alertToDeviceMapping

For Azuga Internal use

Set<AlertToDeviceMappingVO>

smsNotification

Boolean value representing the alert is configured to provide smsNotification

boolean

emailNotification

Boolean value representing the alert is configured to provide emailNotification

boolean

webNotification

Boolean value representing the alert is configured to provide web notification(Banner)

boolean

mobileNotification

Boolean value representing the alert is configured to provide mobile(AFM) notification

boolean

soundNotification

Boolean value representing the alert is configured to notify with sound.

boolean

soundId

The unique id represents the sound notifiers

Integer

emailAdmin

Boolean value representing the alert is configured to email alerts to admin or not

boolean

emailDriver

Boolean value representing the alert is configured to email alerts to drivers or not

boolean

reportFilter

For Azuga Internal use

String

roleIds

Unique identifier of the role which is configured in ‘Group Admin with Role’ under send email section

String

roleIdNames

Name of the roles which is configured in ‘Group Admin with Role’ under send email section

String

alertToAssetSensorMapping

For Azuga Internal use

Set<AlertToAssetSensorMappingDTO>

customAlertHours

The time in hours to send the alert summary report
0 = Trigger the alert instantly
1 = Trigger the alert every 1 hour

Integer

timeForSummary

For Azuga Internal use

String

startTimeForSummary

Start time for summary alert. This is depended on the value of mode.

String

buzzerIntensity

Intensity of the buzzer
53 - High
37 - Medium
21 - Low
5 - Off

Integer

error

The description of the error

List<Error>

Language
Credentials
Header
Click Try It! to start a request and see the response here!