Specialized APIsSensor InsightsAPI Reference

Delete a device profile

DELETE /dm/v1/deviceConfigurationProfiles

Use this endpoint to delete a device profile.

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 NameData TypeDescription
Authorization (required)stringHTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token}
VZ-M2M-Token (required)stringA valid session token returned by a Connectivity Management POST /session/login request.
Content-Type (required)stringMust be application/json.

HTTP Request

DELETE https://thingspace.verizon.com/api/dm/v1/deviceConfigurationProfiles

Request Parameters

Note: All parameters are required unless marked (optional)

ParameterData TypeDescription
accountnamestringThe numeric name of the account and must include leading zeros.
resourceidentifierobjectAn object containing the ID of the device profile.
idstringThe UUID of the profile to delete. A UUID is a 32 to 36-bit alphanumeric string. The ID is assigned when the profile is created.

Request Body

Example Request:

{
  "accountName": "0000123456-00001",
  "resourceidentifier": {
    "id": "string"
  }
}

Success Response

Status 202 This is a synchronous response, so the details of the deleted device profile will be returned. Example Response:

[
  {
    "id": "cb4169ec-eeee-ffff-gggg-d2951060421a",
    "kind": "the kind of profile being created",
    "version": "1.0",
    "versionid": "15bd78a1-eeee-ffff-gggg-86daa842009b",
    "createdon": "2023-10-02T15:46:34.562Z",
    "lastupdated": "2023-10-02T15:46:34.562Z",
    "name": "Demo Entry sensor 1730928792",
    "foreignid": "c1f178d3-eeee-ffff-gggg-0d6b7ae6022a",
    "billingaccountid": "0000123456-00001",
    "modelid": "00000000-0000-0000-0000-000000000019",
    "configuration": {
      "randomInt": 21,
      "resportingInterval": 24
    }
  }
]

Success Parameters

ParameterData TypeDescription
idstringThe UUID of the request. A UUID is a 32 to 36-bit alphanumeric string.
kindstringThe kind of profile created, as per the user.
versionstringthe version of the device profile.
versionidstringThe UUID of the version. A UUID is a 32 to 36-bit alphanumeric string.
createdonstring ($date-time)The timestamp of when the record was created.
lastupdatedstring ($date-time)The timestamp of when the last update to the record was made.
namestringThe user-assigned name of the sensor.
foreignidstringThe UUID value of the user's Enterprise Customer Profile Database (ECPD) account. A UUID is a 32 to 36-bit alphanumeric string.
billingaccountidstringThe numeric name of the account and must include leading zeros. This value matches the accountname.
modelidstringThe UUID of the sensor's model identifier. A UUID is a 32 to 36-bit alphanumeric string. This value is assigned at onboarding.
configurationobjectThe time intervals for the sensor to report data as a default.
randomIntintegerThe reporting interval (in hours) if an event is detected.
reportingIntervalintegerThe reporting interval (in hours) as a default.

Failure Responses

Example Response:

{
  "error": "Error name or code",
  "error_description": "A longer error description.",
  "cause": "A cause for the error"
}

On this page