Suspend an eUICC Device

POST /v1/devices/profile/actions/device_suspend

This API allows the customer to suspend the entire device, including all active Verizon US and Global eSIM profiles.

Bulk operation: Supported (There will be a set of callbacks per device: one for every profile and one final callback at the device level). For profiles that are already suspended; there would be an error callback "Profile is already suspended". Bulk operations have a limit of 10,000 requests.

eSIM profiles: Both Verizon US and Global since this is a device level suspension.

Request Components
Success Response
Callback Response
- Callback Parameters
Failure Responses

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/device_suspend`

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 value of the device ID type.
Parameter kind	Data Typestring	Description The the type of device ID represented by the ID value. Only the following are supported by the request and both values must be present: eid - The Electronic ID of a device
ParameteraccountName required	Data Typestring	DescriptionThe name of the account.

Request Body

Example request:

{
    "devices": [
        {
            "deviceIds": [
                {
                    "kind": "eid",
                    "id": "32-digit EID"
                }
            ]
        }
    ],
    "accountName": "0000123456-00001"
}

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 callbacks, please visit About Callback Services.

Example callback response:

{
   "requestId":"d1f08526-5443-4054-9a29-4456490ea9f8",
   "deviceIds":[
      {
         "id":"32-digit EID",
         "kind":"Eid"
      },
      {
         "id":"20-digit ICCID",
         "kind":"Iccid"
      }
   ],
   "deviceResponse":{
      "deviceProfileResponse":{
         "deviceIdentifierCollection":[
            {
               "id":"32-digit EID",
               "kind":"Eid"
            },
            {
               "id":"20-digit ICCID",
               "kind":"Iccid"
            }
         ],
         "state":"SUSPEND",
         "servicePlan":"service plan name",
         "profileStatus":"DISABLE",
         "profileRole":"LEAD"
      }
   },
   "status":"SUCCESS",
   "callbackCount":1,
   "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 ID values associated with the ICCID being queried. Each deviceId will contain: id kind
Parameter id	Data Typestring	DescriptionThe numeric value of the device ID.
Parameter kind	Data Typestring	Description The the type of device ID represented by the ID value. This could include: Iccid Eid Note: because this is at the device level, EID and ICCID will be the only values used.
ParameterdeviceResponse	Data Typearray	DescriptionContains the deviceProfileResponse, status and number of callback records returned.
ParameterdeviceProfileResponse	Data Typearray	Description Contains the details and status of the device and the request.
Parameter deviceIdentifierCollection	Data Typearray	DescriptionSimilar to deviceIds above.
Parameter state	Data Typestring	DescriptionThe state of the device(s) responding.
Parameter servicePlan	Data Typestring	DescriptionThe name of the service plan associated.
Parameter profileStatus	Data Typestring	Description Indicates the profile state.
Parameter profileRole	Data Typestring	Description This indicates if the profile is LEAD, LOCAL or DEFAULT. Note: If the device has multiple profiles associated, there will be a deviceProfileResponse for each profile.
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!