PUT /v2/triggers

Update the settings of an existing Account Share price plan usage trigger. The trigger may also suspend usage or change the service plan of specified devices. Access to all of the accounts in the profile is required for Account Group Share triggers.

See also:
Create Price Plan Triggers (Profile share)
Update Price Plan Triggers (Pay as you Go)
Update Price Plan Triggers (Stand alone)
Update Price Plan Triggers (Account share)
Get rate plan list
Delete trigger

Request Components

HTTP Request

PUT https://thingspace.verizon.com/api/m2m/v2/triggers

Resource Path and Query Parameters

 

None.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Request Body

The information about the Account Group Share price plan usage trigger that you want to update.

Example Request

{
   "triggerId": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
   "triggerName":"user assigned trigger name",
   "ecpdId":"Verizon profile ID",
   "triggerCategory":"PricePlanDataUsage",
   "pricePlanTrigger":{
      "accountGroupShare":{
         "accountGroupShareIndividual":{
            "filterCriteria":{
               "ratePlanGroupId":73
            },
            "condition":{
               "action":"notify"
            },
            "action":{
               "notify":{
                  "alertType":"individualpriceplan",
                  "threshold":[
                     {
                        "carrierCode":"Service plan code value 1",
                        "percentage":{
                           "percentage50":false,
                           "percentage75":false,
                           "percentage90":true,
                           "percentage100":true
                        }
                     },
                     {
                        "carrierCode":"Service plan code value 2",
                        "percentage":{
                           "percentage50":false,
                           "percentage75":false,
                           "percentage90":true,
                           "percentage100":true
                        }
                     }
                  ]
               }
            }
         }
      }
   },
   "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": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
   "triggerName":"user assigned trigger name",
   "ecpdId":"Verizon profile ID",
   "triggerCategory":"PricePlanDataUsage",
   "pricePlanTrigger":{
      "accountGroupShare":{
         "accountGroupShareIndividual":{
            "filterCriteria":{
               "ratePlanGroupId":73
            },
            "condition":{
               "action":"suspend"
            },
            "action":{
               "suspend":{
                  "suspendDuration":"NextBillCycle",
                  "suspendOption":"withoutBilling",
                  "alertType":"individualpriceplan",
                  "threshold":[
                     {
                        "carrierCode":"Service plan code value 1",
                        "usagePercentage":50
                     },
                     {
                        "carrierCode":"Service plan code value 2",
                        "usagePercentage":90
                     }
                  ]
               }
            }
         }
      }
   },
   "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": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
   "triggerName":"user assigned trigger name",
   "ecpdId":"Verizon profile ID",
   "triggerCategory":"PricePlanDataUsage",
   "pricePlanTrigger":{
      "accountGroupShare":{
         "accountGroupShareIndividual":{
            "filterCriteria":{
               "ratePlanGroupId":73
            },
            "condition":{
               "action":"changePricePlan"
            },
            "action":{
               "changePlan":{
                  "sharePlan":[
                     {
                        "fromCarrierCode":"Service plan code value 1",
                        "toCarrierCode":"Service plan code value 2",
                        "criteriaPercentage":50
                     },
                     {
                        "fromCarrierCode":"Service plan code value 2",
                        "toCarrierCode":"Service plan code value 3",
                        "criteriaPercentage":75
                     }
                  ],
                  "triggerDate":"BackDate"
               }
            }
         }
      }
   },
   "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": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
   "triggerName":"user assigned trigger name",
   "ecpdId":"Verizon profile ID",
   "triggerCategory":"PricePlanDataUsage",
   "pricePlanTrigger":{
      "accountGroupShare":{
         "accountGroupSharePool":{
            "filterCriteria":{
               "ratePlanGroupId":73
            },
            "condition":{
               "action":"notify"
            },
            "action":{
               "notify":{
                  "threshold":[
                     {
                        "percentage":{
                           "percentage50":false,
                           "percentage75":false,
                           "percentage90":true,
                           "percentage100":true
                        }
                     }
                  ]
               }
            }
         }
      }
   },
   "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": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
   "triggerName":"user assigned trigger name",
   "ecpdId":"Verizon profile ID",
   "triggerCategory":"PricePlanDataUsage",
   "pricePlanTrigger":{
      "accountGroupShare":{
         "accountGroupSharePool":{
            "filterCriteria":{
               "ratePlanGroupId":73
            },
            "condition":{
               "action":"changePricePlan"
            },
            "action":{
               "automation":"customerAutomation",
               "changePlan":{
                  "changePlanGT":{
                     "changePlan":[
                        {
                           "fromCarrierCode":"Service plan code value 1",
                           "toCarrierCode":"Service plan code value 2"
                        },
                        {
                           "fromCarrierCode":"Service plan code value 2",
                           "toCarrierCode":"Service plan code value 3"
                        }
                     ],
                     "dataPoolOverageBuffer":15,
                     "triggerDate":"CurrentDate"
                  },
                  "changePlanLT":{
                     "changePlan":[
                        {
                           "fromCarrierCode":"Service plan code value 3",
                           "toCarrierCode":"Service plan code value 2"
                        },
                        {
                           "fromCarrierCode":"Service plan code value 2",
                           "toCarrierCode":"Service plan code value 1"
                        }
                     ],
                     "dataPoolOverageBuffer":95,
                     "triggerDate":"CurrentDate"
                  }
               }
            }
         }
      }
   },
   "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
}

Callback Examples

{
    "username": "user making the request",
    "password": "user's password",
    "requestId": "system generated request ID",
    "deviceResponse": {
        "alertServiceResponse": {
            "triggerId": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
            "triggerName": "user assigned trigger name",
            "triggerCategory": "PricePlanDataUsage",
            "triggerDateTime": "3/14/2023 3:00:34 PM",
            "accountGroupShare": {
                "carrierServicePlanCode": "service plan code value",
                "servicePlanDescription": "description of the service plan",
                "servicePlanGroupId": 73,
                "deviceIds": [
                    {
                        "id": "15-digit IMEI",
                        "kind": "IMEI"
                    }
                ],
                "allowance": 26843545600,
                "message": "AccountGroupShare Service Plan {Service Plan Code Value} has an overage of 50% at 13107200 kb"
            }
        }
    },
    "callbackCount": 1,
    "maxCallbackThreshold": 4
}

{
    "username": "user making the request",
    "password": "user's password",
    "requestId": "system generated request ID",
    "deviceResponse": {
        "alertServiceResponse": {
            "triggerId": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
            "triggerName": "user assigned trigger name",
            "triggerCategory": "PricePlanDataUsage",
            "triggerDateTime": "3/14/2023 3:00:34 PM",
            "accountGroupShare": {
                "carrierServicePlanCode": "service plan code value",
                "servicePlanDescription": "description of the service plan",
                "servicePlanGroupId": 73,
                "deviceIds": [
                    {
                        "id": "15-digit IMEI",
                        "kind": "IMEI"
                    }
                ],
                "allowance": 26843545600,
                "action": {
                    "suspendDetails": {
                        "suspendDuration": "90Days",
                        "suspendOption": "WithoutBilling"
                    }
                },
                "message": "AccountGroupShare Service Plan {Service Plan Code Value} has an overage of 50% at 13107200 kb"
            }
        }
    },
    "callbackCount": 1,
    "maxCallbackThreshold": 4
}

{
    "username": "user making the request",
    "password": "user's password",
    "requestId": "system generated request ID",
    "deviceResponse": {
        "alertServiceResponse": {
            "triggerId": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
            "triggerName": "user assigned trigger name",
            "triggerCategory": "PricePlanDataUsage",
            "triggerDateTime": "3/14/2023 3:00:34 PM",
            "accountGroupShare": {
                "carrierServicePlanCode": "service plan code value",
                "servicePlanDescription": "description of the service plan",
                "servicePlanGroupId": 73,
                "deviceIds": [
                    {
                        "id": "15-digit IMEI",
                        "kind": "IMEI"
                    }
                ],
                "allowance": 26843545600,
                "action": {
                    "changePlan": {
                        "fromCarrierServicePlanCode": "service plan code value",
                        "fromServicePlanDescription": "description of the service plan",
                        "toCarrierServicePlanCode": "service plan code value 2",
                        "toServicePlanDescription": "description of the service plan 2",
                        "effectiveDate": "2023-03-14T21:15:27.1380000Z"
                    }
                },
                "message": "AccountGroupShare Service Plan {Service Plan Code Value} has an overage of 50% at 13107200 kb"
            }
        }
    },
    "callbackCount": 1,
    "maxCallbackThreshold": 4
}

{
    "username": "user making the request",
    "password": "user's password",
    "requestId": "system generated request ID",
    "deviceResponse": {
        "alertServiceResponse": {
            "triggerId": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
            "triggerName": "user assigned trigger name",
            "triggerCategory": "PricePlanDataUsage",
            "triggerDateTime": "3/14/2023 3:00:34 PM",
            "accountGroupShare": {
                "servicePlanGroupId": 73,
                "allowance": 26843545600,
                "message": "AccountGroupShare Service Plan has an overage of 50% at 13107200 kb"
            }
        }
    },
    "callbackCount": 1,
    "maxCallbackThreshold": 4
}

{
    "username": "user making the request",
    "password": "user's password",
    "requestId": "system generated request ID",
    "deviceResponse": {
        "alertServiceResponse": {
            "triggerId": "b9cc1da6-89d8-4b52-b91a-7eba8859ab5e",
            "triggerName": "user assigned trigger name",
            "triggerCategory": "PricePlanDataUsage",
            "triggerDateTime": "3/14/2023 3:00:34 PM",
            "message": "Account Group Share {group description} used less than 100% of the group allowance",
            "accountGroupShare": {
                "servicePlanGroupId": 73,
                "allowance": 26843545600,
    "action": {
                    "changePlan": {
                        "changePlanAutomation": "customer Automation",
                        "lessThan100Percentage": {
                            "effectiveDate": "2023-03-14T22:13:12.2800000Z",
                            "bufferReduced": "87",
                            "devicePerPricePlan": [
                                {
                                    "deviceCount": 8,
                                    "fromCarrierServicePlanCode": "service plan Id 1",
                                    "fromServicePlanDescription": "description of the service plan 1",
                                    "toCarrierServicePlanCode": "service plan Id 2",
                                    "toServicePlanDescription": "description of the service plan 2"
                                },
                                {
                                    "deviceCount": 3,
                                    "fromCarrierServicePlanCode": "service plan Id 3",
                                    "fromServicePlanDescription": "description of the service plan 3",
                                    "toCarrierServicePlanCode": "service plan Id 2",
                                    "toServicePlanDescription": "description of the service plan 2"
                                }
                            ]
                        }
                    }

                "message": "AccountGroupShare {group description} has low usage of less than 100% at 52428800 KB. Attempted to decrease buffer to 80%. Able to achieve decrease to 87%"
            }
        }
    },
    "callbackCount": 1,
    "maxCallbackThreshold": 4
}

Callback Body Parameters

For more information about callbacks, please visit About Callback Services

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!