Update Usage Trigger
POST /usage/triggers/{triggerId}
Change the settings of an existing trigger.
Uses and Requirements
Note: This method uses the /subsc/v1 basepath, not /loc/v1 used by other Device Location API requests.
HTTP Request
POST https://thingspace.verizon.com/api/subsc/v1/usage/triggers/{triggerId}
Resource Path and Query Parameters
You must include the unique ID of the trigger that you want to update in the path.
| Parameter Name | Data Type | Description |
|---|---|---|
| triggerId (required) | string | The unique ID of the trigger to update. The ID was returned in the response when the trigger was created, and you can also find it in the GET /triggers response. |
Header Parameters
The request header must 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 returned by POST /api/m2m/v1/session/login using the primary account’s UWS credentials. |
| Content-Type (required) | string | Must be application/json: Content-Type: application/json. |
Request Body
The request body contains the account name and the trigger parameters that you want to change.
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName (required) | string | The Verizon billing account that the trigger belongs to. You cannot move a trigger to a different account. |
| triggerName (required) | string | A new, unique name of the trigger. |
| thresholdValue (required) | string | The percent of subscribed usage required to activate the trigger, such as 90 or 100. |
| smsPhoneNumbers (optional) | string | A comma-separated list of phone numbers to send SMS alerts to. Digits only; no dashes or parentheses, etc. This list will replace any existing list of phone numbers. |
| emailAddresses (optional) | string | A comma-separated list of email addresses to send email alerts to. This list will replace any existing list of email addresses. |
Example Request Body
Update a usage trigger to change the thresholdValue.
{
"accountName": "1000012345-00001",
"thresholdValue": "95"
}Success Responses
Status 200
A success response contains the complete settings of the trigger resource.
Example Success Response
{
"triggerId": "595f5c44-eeee-ffff-gggg-020a1545a84d",
"triggerName": "Location usage warning",
"accountName": "1234567890-00001",
"serviceName": "Location",
"thresholdValue": "95",
"allowExcess": true,
"sendSmsNotification": true,
"smsPhoneNumbers": "10-digit phone number",
"sendEmailNotification": false,
"emailAddresses": "",
"createDate": "2018-06-11",
"updateDate": "2018-06-12"
}Failure Responses
All error messages are returned in this format:
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}Error codes and messages are listed on the Error Codes page, along with explanations and suggestions for corrective actions.