Add or Remove Devices in an Upgrade

`PUT /campaigns/{acc}/{campaignId}`

Allows you to add or remove devices from a software upgrade.

Uses and Requirements

You cannot add or remove devices once an upgrade is in a Scheduled state. To add or remove devices, the campaign must be in one of the following states:

RequestPending
Queued

Request Components

HTTP Request

PUT https://thingspace.verizon.com/api/fota/v2/campaigns/{acc}/{campaignId}

Resource Path and Query Parameters

Parameter Name	Data Type	Description
acc required	string	Account identifier.
campaignId required	string	Software upgrade identifier, returned in the "id" value of the `POST /{campaigns}/acc` response when the upgrade was scheduled.

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

Parameter Name	Data Type	Description
addOrRemoveDevice	object	Adds or removes devices to existing software upgrade information.
addOrRemoveDevice.Type	string	The type of action you want to take. Valid values include: append remove
addOrRemoveDevice.deviceList	object	List of device IMEIs.

Example Request

Request a software upgrade.

curl -X PUT https://thingspace.verizon.com/api/fota/v2/campaigns/$ACC/$CAMPAIGN_ID -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN' -H 'Content-Type: application/json' -d
{
  "addOrRemoveDevice": [
   {
     "type": "remove",
     "deviceList":[
     "990013907884259",
     "990013907835573",
     "990013907833575"
      ]
    }
  ]
}

Success Responses

Status 200

Parameter Name	Data Type	Description
accountName	string	The account name.
campaignId	string	Software upgrade identifier, returned in the “id” value of the POST /{campaigns}/acc response when the upgrade was scheduled.
requestId	string	Request identifier.

Example Success Response

{
  "accountName": "0402196254-00001",
  "campaignId": "60b5d639-ccdc-4db8-8824-069bd94c95bf",
  "requestId": "string"
}

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.