Delete Cancellation Candidate List

Delete the Cancellation Candidate List:
DELETE /licenses/{account}/cancel

Deletes the entire list of cancellation candidate devices.

Note: This request is only used with accounts that have a monthly recurring charge (MRC) subscription. Accounts with event-based billing do not need to track licenses.

Contents

See also:
Create cancellation candidate List
Retrieve list of cancellation candidate devices

Uses and Requirements

If the number of subscribed licenses is reduced to where it is less than the number of assigned licenses, ThingSpace will remove licenses from as many devices as needed to match the subscribed amount. If there is no cancellation candidate list, ThingSpace will remove licenses from devices, starting with the first licenses assigned (FIFO).

Request Components

HTTP Request

DELETE https://thingspace.verizon.com/api/fota/v1/licenses/{account}/cancel

Resource Path and Query Parameters

You must include the account name in the path.

Parameter Name Data Type Description
account
required
string The name of the account from which you want to delete the cancellation candidate list. An account name is usually numeric, and must include any leading zeros.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization request header containing a valid Bearer token.
VZ-M2M-Token
required
string A valid session token returned by a Connectivity Management POST /session/login request.

Request Body

None.

Success Responses

Status 200

A response to a successful request contains a single Boolean value:

{
  "success": true
}

Failure Responses

Status 400

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.