Deactivate a Device (for eUICC)

`POST /devices/profile/actions/deactivate`

Deactivate a eUICC device, or multiple devices, for a profile.

Request Components
Success Response
Callback Response
- Callback Parameters
Failure Responses

See also:

POST /devices/profile/actions/activate_enable - Activate Enable a device
POST /devices/profile/actions/delete - Delete a device

Request Components

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
Parameter NameAuthorization required	Data Typestring	Description HTTP Authorization bearer token: `Authorization: Bearer {token}`
Parameter NameVZ-M2M-Token required	Data Typestring	Description A valid session token: `VZ-M2M-Token: {M2Mtoken}`
Parameter NameContent-Type required	Data Typestring	Description Must be application/json: `Content-Type: application/json`

HTTP Request

`POST https://thingspace.verizon.com/api/m2m/v1//devices/profile/actions/deactivate`

Request Parameters

Parameter	Data Type	Description
Parameter devices required	Data Typearray	Description An array of deviceIds. Each deviceId will contain: id kind
Parameter id	Data Typestring	DescriptionThe numeric ID of the device.
Parameter kind	Data Typestring	Description The the type of device ID represented by the ID value. This could be: imei iccid mdn eid
ParameteraccountName required	Data Typestring	DescriptionThe name of the account.
ParametercarrierName	Data Typestring	DescriptionThe carrier providing cellular network access.
ParameterreasonCode	Data Typestring	DescriptionA note or reason why the change is being made.
Parameteretfwaiver	Data Typeboolean	Description This flags a billing modification and indicates if the customer wants to use an Early Termination Fee waiver (true) or not (false) for this transaction.
ParametercheckFallbackProfile	Data Typeboolean	DescriptionAn indicator of the fallback being set or not .

Request Body

Example request:

{
   "devices":[
      {
         "deviceIds":[
            {
               "id":"15-digit IMEI",
               "kind":"imei"
            },
            {
               "id":"32-digit EID",
               "kind":"eid"
            }
         ]
      }
   ],
   "accountName":"0000123456-00001",
   "carrierName":"name of the mobile service provider",
   "reasonCode":"string",
   "etfWaiver":false,
   "checkFallbackProfile":false
}

Success Response

Status 200

A successful response shows a system generated request ID to track the request.

Example Response:

{
  "requestId": "d1f08526-5443-4054-9a29-4456490ea9f8"
}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required.To learn more about callback, please visti About Callback Services.

Example callback response:

{
   "username":"username",
   "password":"password",
   "requestId":"d1f08526-5443-4054-9a29-4456490ea9f8",
   "deviceIds":[
      {
         "id":"20-digit ICCID",
         "kind":"iccid"
      },
      {
         "id":"15-digit IMEI",
         "kind":"imei"
      },
      {
         "id":"32-digit EID",
         "kind":"eid"
      }
   ],
   "deviceResponse":{
      "deviceProfileResponse":{
         "deviceIdentifierCollection":[
            {
               "id":"20-digit ICCID",
               "kind":"iccid"
            },
            {
               "id":"10-digit MDN",
               "kind":"mdn"
            },
            {
               "id":"32-digit EID",
               "kind":"eid"
            }
         ],
         "state":"Deactive",
         "smsrOid":"1.3.6.1.4.1.31746.1.500.200.101.5",
         "profileStatus":"ENABLE",
         "euiccStatus":"EXECUTED_SUCCESS",
         "euiccStatusCode":"1.2.365",
         "euiccStatusDesc":"EUICC device profile has been updated",
         "euiccSubAddressUpdateStatus":"EXECUTED_SUCCESS",
         "euiccSubAddressUpdateStatusCode":"1",
         "euiccSubAddressUpdateStatusDesc":"SUCCESS: Address has been updated"
      }
   },
   "status":"Success",
   "callbackCount":4,
   "maxCallbackThreshold":4
}

Callback Parameters

Parameter	Data Type	Description
ParameterrequestId	Data Typestring	DescriptionThe requestId being viewed. This is a system generated value from the request above.
ParameterdeviceIds	Data Typearray	Description An array of devices being queried by the request. Each deviceId will contain: id kind
Parameter id	Data Typestring	DescriptionThe numeric ID of the device.
Parameter kind	Data Typestring	Description The the type of device ID represented by the ID value. This could be: imei iccid mdn eid
ParameterdeviceResponse	Data Typearray	DescriptionContains the deviceProfileResponse, status and number of callback records returned.
ParameterdeviceProfileResponse	Data Typearray	Description Contains the details and status of the devices and the request.
Parameter deviceIdentifierCollection	Data Typearray	DescriptionSimilar to deviceIds above, but this lists the available identifiers for devices responding.
Parameter state	Data Typestring	DescriptionThe state of the device(s) responding.
Parameter profileStatus	Data Typestring	DescriptionIndicates the profile state and will show what request was made.
Parameter euiccStatus	Data Typestring	DescriptionThis shows how the device, or devices, has responded to the request. eUICC is embedded universal integrated circuit card and refers to the SIM card for the device. For more information, visit Working with eUICC Devices.
Parameter euiccStatusCode	Data Typestring	DescriptionThe system generated status code for an eUICC device.
Parameter euiccStatusDesc	Data Typestring	DescriptionDescription of the eUICC status code
Parameter euiccSubAddressUpdateStatus	Data Typestring	DescriptionStatus of any address update requests.
Parameter euiccSubAddressUpdateStatusCode	Data Typestring	DescriptionA system generated status code for an address update request.
Parameter euiccSubAddressUpdateStatusDesc	Data Typestring	DescriptionA description of the status code from above.
Parameterstatus	Data Typestring	DescriptionThe status of the deviceResponse.
ParametercallbackCount	Data Typestring	DescriptionThe number of responses for deviceResponse found.
ParametermaxCallbackThreshold	Data Typestring	DescriptionThe maximum number of responses for deviceResponse allowed.

Failure Responses

All error responses will be in the following format

{
  "errorCode": "The 3-digit HTML error code",
  "errorMessage": "string"
}

Try It Out!