Create Price Plan Triggers
createTriggerRules
Create a usage trigger at the account level, device level or a price plan trigger for all devices on the account
AuthorizationBearer <token>
This is the ThingSpace token, from Credentials and Tokens is used
In: header
Request Body
application/json
Create a trigger
Create a trigger
Create a trigger
triggerName?string
The user defined name of the trigger
ecpdId?string
The Enterprise Customer Profile Database ID
triggerCategory?triggerCategory
The type of trigger being created or modified
Value in
- "AccountUsage"
- "DeviceGroupUsage"
- "PricePlanDataUsage"
dataTrigger?
notification?
notificationType?string
callback?boolean
emailNotification?boolean
notificationGroupName?string
notificationFrequencyFactor?integer
Format
int32notificationFrequencyInterval?string
externalEmailRecipients?string
smsNotification?boolean
smsNumbers?array<|>
reminder?boolean
severity?string
active?active
A flag to indicate of the trigger is active, true, or not, false
Value in
- "true"
- "false"
Response Body
application/json
application/json
curl -X POST "https://example.com/v2/triggers" \ -H "Content-Type: application/json" \ -d '{ "triggerName": "name of the trigger", "ecpdId": "Verizon profile ID", "triggerCategory": "AccountUsage", "dataTrigger": { "accountLevel": { "filterCriteria": { "separateOrCombined": "Separate", "accountNames": { "accountNameList": [ "0000123456-00001" ] } }, "condition": { "comparator": "gt", "threshold": 100, "thresholdUnit": "KB", "cycleType": "Daily" }, "action": { "suspend": true, "suspendDetails": { "suspendFromAccounts": [ "0000123456-00001" ], "suspendDuration": "90", "suspendOption": "withBilling", "threshold": 50, "thresholdUnit": "KB" } } } }, "notification": { "notificationType": "PerEvent", "callback": true, "emailNotification": false, "notificationGroupName": "NotificationGroupName", "notificationFrequencyFactor": 3, "notificationFrequencyInterval": "Daily", "externalEmailRecipients": "ExternalEmailRecipients", "smsNotification": true, "smsNumbers": [ { "number": "10-digit mobile number", "carrier": "mobile service provider" }, { "number": "10-digit mobile number", "carrier": "mobile service provider" } ], "reminder": true, "severity": "Notice" }, "active": "true" }'{ "triggerId": "be1b5958-ffff-eeee-gggg-b1b7618c0035"}