Delete a device for the specified customer

Article
09/11/2024

Applies to: Partner Center

This article explains how to delete a device that belongs to a specified customer.

Prerequisites

Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.
A customer ID (customer-tenant-id). If you don't know the customer's ID, you can look it up in Partner Center by selecting the Customers workspace, then the customer from the customer list, then Account. On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. The Microsoft ID is the same as the customer ID (customer-tenant-id).
The device batch identifier.
The device identifier.

C#

To delete a device for the specified customer:

Call the IAggregatePartner.Customers.ById method with the customer identifier to retrieve an interface to operations on the customer.
Call the DeviceBatches.ById method with the device batch identifier to get an interface to operations for the specified batch.
Call the Devices.ById method to get an interface to operation on the specified device.
Call the Delete or DeleteAsync method to delete the device from the batch.

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedDeviceBatchId;
string selectedDeviceId;

partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.ById(selectedDeviceBatchId).Devices.ById(selectedDeviceId).Delete();

Sample: Console test app. Project: Partner Center SDK Samples Class: DeleteDevice.cs

REST request

Request syntax

Method	Request URI
DELETE	{baseURL}/v1/customers/{customer-id}/deviceBatches/{devicebatch-id}/devices/{device-id} HTTP/1.1

URI parameters

Use the following path parameters when creating the request.

Name	Type	Required	Description
customer-id	string	Yes	A GUID-formatted string that identifies the customer.
devicebatch-id	string	Yes	The device batch identifier of the batch that contains the device.
device-id	string	Yes	The device identifier.

Request headers

For more information, see Partner Center REST headers.

Request body

None

Request example

DELETE https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatches/testbatch/devices/7b11cd8b-dd1e-4840-8c4a-84215e4de782 HTTP/1.1
Authorization: Bearer <token>
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Content-Length: 0
Content-Type: application/json
Host: api.partnercenter.microsoft.com

REST response

If successful, the response returns a 204 No Content status code.

Response success and error codes

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. For the full list, see Partner Center REST error codes.

Response example

HTTP/1.1 204 No Content
Content-Length: 0
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 8b3e6f78-220b-4177-861b-33d6f38f7b97
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 17:58:53 GMT

Share via