V2 Triggers Request
V2TriggersRequest
Any of
accountLevelCreateTriggerRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
triggerName | string | No | The user defined name of the trigger |
ecpdId | string | No | The Enterprise Customer Profile Database ID |
triggerCategory | string (one of: AccountUsage, DeviceGroupUsage, PricePlanDataUsage) | No | The type of trigger being created or modified |
dataTrigger | object | No | |
notification | object | No | |
notificationType | string | No | |
callback | boolean | No | |
emailNotification | boolean | No | |
notificationGroupName | string | No | |
notificationFrequencyFactor | integer | No | |
notificationFrequencyInterval | string | No | |
externalEmailRecipients | string | No | |
smsNotification | boolean | No | |
smsNumbers | array | No | |
reminder | boolean | No | |
severity | string | No | |
active | string (one of: true, false) | No | A flag to indicate of the trigger is active, true, or not, false |
accountLevelObject
Properties
| Name | Type | Required | Description |
|---|---|---|---|
filterCriteria | object | No | |
condition | any | No | |
action | string (one of: notify, suspend, changePricePlan) | No | The action taken when trigger conditions are met |
deviceLevelCreateTriggerRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
triggerName | string | No | The user defined name of the trigger |
ecpdId | string | No | The Enterprise Customer Profile Database ID |
triggerCategory | string (one of: AccountUsage, DeviceGroupUsage, PricePlanDataUsage) | No | The type of trigger being created or modified |
dataTrigger | object | No | |
notification | object | No | |
active | string (one of: true, false) | No | A flag to indicate of the trigger is active, true, or not, false |
accountGroupShareCreateTriggerRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
triggerName | string | No | The user defined name of the trigger |
accountName | string | No | The numeric name of the account and must include leading zeroes |
triggerCategory | string (one of: AccountUsage, DeviceGroupUsage, PricePlanDataUsage) | No | The type of trigger being created or modified |
pricePlanTrigger | object | No | |
notification | object | No | |
active | string (one of: true, false) | No | A flag to indicate of the trigger is active, true, or not, false |
accountShareCreateTriggerRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
triggerName | string | No | The user defined name of the trigger |
ecpdId | string | No | The Enterprise Customer Profile Database ID |
triggerCategory | string (one of: AccountUsage, DeviceGroupUsage, PricePlanDataUsage) | No | The type of trigger being created or modified |
pricePlanTrigger | any | No | |
notification | any | No | |
active | string (one of: true, false) | No | A flag to indicate of the trigger is active, true, or not, false |
payAsYouGoCreateTriggerRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
triggerName | string | No | The user defined name of the trigger |
ecpdId | string | No | The Enterprise Customer Profile Database ID |
triggerCategory | string (one of: AccountUsage, DeviceGroupUsage, PricePlanDataUsage) | No | The type of trigger being created or modified |
pricePlanTrigger | any | No | |
notification | any | No | |
active | string (one of: true, false) | No | A flag to indicate of the trigger is active, true, or not, false |
createtriggerchunk
Properties
| Name | Type | Required | Description |
|---|---|---|---|
triggerName | string | No | The user defined name of the trigger |
ecpdId | string | No | The Enterprise Customer Profile Database ID |
triggerCategory | string (one of: AccountUsage, DeviceGroupUsage, PricePlanDataUsage) | No | The type of trigger being created or modified |
pricePlanTrigger | any | No | |
notification | any | No | |
active | string (one of: true, false) | No | A flag to indicate of the trigger is active, true, or not, false |