Standard APIsReady SIMAPI EndpointsUpdate TriggersUpdate All Available Triggers
API Reference
Update Promotional Triggers
PUT /v2/triggers
Updating a trigger for MDNless is similar to retrieving any trigger in Connectivity Management. The only difference is a few new values added in the response for MDNless. This page will cover the new values and provide examples of what responses look like with the new values.
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token: VZ-M2M-Token: {M2Mtoken} |
| Content-Type (required) | string | Must be application/json Content-Type: application/json |
HTTP Request
PUT https://thingspace.verizon.com/api/m2m/v2/triggers
Request Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| triggerId | string | The system assigned ID of the Trigger. |
| triggerName | object | The system assigned name of the trigger. When the trigger is associated with MDNless, the name will show PromoAlerts. |
| accountName | string | The name of the account. An account name is usually numeric and must include any leading zeros. |
| organizationName | string | An optional group name added when the trigger is created. |
| triggerCategory | string | The category of the trigger. for MDNless this category will always be PromoAlerts |
| promoAlerts | array | An array of additional information for the trigger. |
| promoAlerts.filterCriteria | object | The filter information used to identify the trigger. |
| promoalerts.condition | string | The conditons, or thresholds, for the trigger to respond. |
| promoAlerts.condition.DataPercentage50 | boolean | Whether or not the usage has exceeded 50% of the account's total usage allowed.
|
| promoAlerts.condition.DataPercentage75 | boolean | Whether or not the usage has exceeded 75% of the account's total usage allowed.
|
| promoAlerts.DataPercentage90 | boolean | Whether or not the usage has exceeded 90% of the account's total usage allowed.
|
| promoAlerts.condition.DataPercentage100 | boolean | Whether or not the usage has exceeded 100% of the account's total usage allowed.
|
| promoAlerts.condition.SmsPercentage50 | boolean | Whether or not the number of SMS messages has exceeded 50% of the account's total usage allowed.
|
| promoAlerts.condition.SmsPercentage75 | boolean | Whether or not the number of SMS messages has exceeded 75% of the account's total usage allowed.
|
| promoAlerts.condition.SmsPercentage90 | boolean | Whether or not the number of SMS messages has exceeded 90% of the account's total usage allowed.
|
| promoAlerts.condition.SmsPercentage100 | boolean | Whether or not the number of SMS messages has exceeded 100% of the account's total usage allowed.
|
| promoAlerts.condition.NoOfDaysB4PromoExp | integer | The number of days until the promotional billing rate for MDNless ends. |
| promoAlerts.EnablePromo | boolean | Whether or not the promotional billing rate is enabled.
|
Request Body
Example Request Body:
{
"triggerId": "0C82E389-1305-40C7-8DD3-E6FDDC984F7D",
"triggerName": "PromoAlerts_0000123456-00001_12345",
"accountName": "0000123456-00001",
"organizationName": "Mdnless_org_name",
"triggerCategory": "PromoAlerts",
"promoAlerts": {
"filterCriteria": {},
"condition": {
"dataPercentage50": false,
"dataPercentage75": false,
"dataPercentage90": false,
"dataPercentage100": true,
"smsPercentage50": false,
"smsPercentage75": false,
"smsPercentage90": false,
"smsPercentage100": true,
"noOfDaysB4PromoExp": 0
},
"enablePromo": true
}
}Success Responses
Status 200 Example Success Response:
{
"status": "Success"
}Failure Responses
All failure responses are in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.