Premium APIsSoftware ManagementSoftware Management V3API Reference Pages V3
Cancel a Sheduled Upgrade
Cancel a Scheduled Upgrade
DELETE /campaigns/{accountName}/{campaignId}
Allows a software upgrade to be cancelled. A software upgrade can be canceled before the start date. Once the campaign has started, it cannot be canceled. The campaign will continue through the scheduled end date.
HTTP Request
DELETE https://thingspace.verizon.com/api/fota/v3/campaigns/{accountName}/{campaignId}
Header Parameters
The request header must contain a current ThingSpace authorization token, set the content to "JSON" and a current VZ-M2M-session token.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
Request Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName (required) | string | Account identifier. This is numeric and in the format of 0000123456-00001. Leading zeros must be included. |
| campaignId (required) | string | Software upgrade identifier, returned in the "id" value of the POST /{campaigns}/{accountName} response when the upgrade was scheduled. |
Request Body
None
Success Responses
Status 200 Example Success Response
{
"success": true
}Success Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| success | boolean | true (succeeded) or false (failed). |
Failure Responses
All error messages are returned 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.