Update device details such as device name, asset tag, etc.

modifies particular device details

Endpoints

put /api/v1/mdm/devices/{device_id}

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/devices/{device_id}

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

device_idstringMandatory

Unique identifier of the device. Obtain from the Get Device List response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

namestringOptional

Name of the device

device_namestringOptional

Display name of the device

descriptionstringOptional

Description of the device

asset_tagstringOptional

Asset tag information for the device

asset_ownerstringOptional

Owner of the device asset

officestringOptional

Office location assigned to the device

branchstringOptional

Branch location of the device

locationstringOptional

Physical location of the device

area_managerstringOptional

Area manager responsible for the device

purchase_datestringOptional

Purchase date in milliseconds since epoch

purchase_order_numberstringOptional

Purchase order number for the device

purchase_pricestringOptional

Purchase price of the device

purchase_typestringOptional

Purchase type of the device (e.g., Reseller, Vendor)

warranty_expiration_datestringOptional

Warranty expiration date in milliseconds since epoch

warranty_numberstringOptional

Warranty number of the device

warranty_typestringOptional

Warranty type (e.g., WithService, WithoutService)

apn_usernamestringOptional

APN username for the device

apn_passwordstringOptional

APN password for the device

assigned_fencesJSON ArrayOptional

Show Sub-Attributes

string

registered_timestringOptional

Device registration time in milliseconds since epoch

enrollment_request_timestringOptional

Enrollment request time in milliseconds since epoch

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/devices/{device_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"purchase_type":"Reseller","warranty_number":"SJSU64728372","apn_password":"zylker@123","asset_tag":"ZY-IPAD-0012","description":"Belong to Zylker Inc - Sales Team","enrollment_request_time":1527984500000,"office":"North Plaza,CA","warranty_type":"WithService","branch":"North America - Plaza","apn_username":"zylker","device_name":"Zylker-Sales-iPad-12","warranty_expiration_date":1530057600000,"registered_time":1527984000000,"name":"Zylker-Sales-iPad-12","purchase_price":"65000","asset_owner":"John Smith","purchase_order_number":"SR2Ik56779","location":"Building 3, Floor 2","area_manager":"Mary Doe","purchase_date":1527984000000}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/devices/{device_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"purchase_type\":\"Reseller\",\"warranty_number\":\"SJSU64728372\",\"apn_password\":\"zylker@123\",\"asset_tag\":\"ZY-IPAD-0012\",\"description\":\"Belong to Zylker Inc - Sales Team\",\"enrollment_request_time\":1527984500000,\"office\":\"North Plaza,CA\",\"warranty_type\":\"WithService\",\"branch\":\"North America - Plaza\",\"apn_username\":\"zylker\",\"device_name\":\"Zylker-Sales-iPad-12\",\"warranty_expiration_date\":1530057600000,\"registered_time\":1527984000000,\"name\":\"Zylker-Sales-iPad-12\",\"purchase_price\":\"65000\",\"asset_owner\":\"John Smith\",\"purchase_order_number\":\"SR2Ik56779\",\"location\":\"Building 3, Floor 2\",\"area_manager\":\"Mary Doe\",\"purchase_date\":1527984000000}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"purchase_type\":\"Reseller\",\"warranty_number\":\"SJSU64728372\",\"apn_password\":\"zylker@123\",\"asset_tag\":\"ZY-IPAD-0012\",\"description\":\"Belong to Zylker Inc - Sales Team\",\"enrollment_request_time\":1527984500000,\"office\":\"North Plaza,CA\",\"warranty_type\":\"WithService\",\"branch\":\"North America - Plaza\",\"apn_username\":\"zylker\",\"device_name\":\"Zylker-Sales-iPad-12\",\"warranty_expiration_date\":1530057600000,\"registered_time\":1527984000000,\"name\":\"Zylker-Sales-iPad-12\",\"purchase_price\":\"65000\",\"asset_owner\":\"John Smith\",\"purchase_order_number\":\"SR2Ik56779\",\"location\":\"Building 3, Floor 2\",\"area_manager\":\"Mary Doe\",\"purchase_date\":1527984000000}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/devices/{device_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("name","value");
    data.put("device_name","value");
    data.put("description","value");
    data.put("asset_tag","value");
    data.put("asset_owner","value");
    data.put("office","value");
    data.put("branch","value");
    data.put("location","value");
    data.put("area_manager","value");
    data.put("purchase_date","value");
    data.put("purchase_order_number","value");
    data.put("purchase_price","value");
    data.put("purchase_type","value");
    data.put("warranty_expiration_date","value");
    data.put("warranty_number","value");
    data.put("warranty_type","value");
    data.put("apn_username","value");
    data.put("apn_password","value");
    data_assigned_fences=List();
    data_assigned_fences.add("value");
    data.put("assigned_fences",data_assigned_fences);
    data.put("registered_time","value");
    data.put("enrollment_request_time","value");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/devices/{device_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/devices/{device_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"purchase_type":"Reseller","warranty_number":"SJSU64728372","apn_password":"zylker@123","asset_tag":"ZY-IPAD-0012","description":"Belong to Zylker Inc - Sales Team","enrollment_request_time":1527984500000,"office":"North Plaza,CA","warranty_type":"WithService","branch":"North America - Plaza","apn_username":"zylker","device_name":"Zylker-Sales-iPad-12","warranty_expiration_date":1530057600000,"registered_time":1527984000000,"name":"Zylker-Sales-iPad-12","purchase_price":"65000","asset_owner":"John Smith","purchase_order_number":"SR2Ik56779","location":"Building 3, Floor 2","area_manager":"Mary Doe","purchase_date":1527984000000}'

Sample Request Body

Update editable device attributes such as asset/warranty/owner information

Copied!

  {
    "purchase_type": "Reseller",
    "warranty_number": "SJSU64728372",
    "apn_password": "zylker@123",
    "asset_tag": "ZY-IPAD-0012",
    "description": "Belong to Zylker Inc - Sales Team",
    "enrollment_request_time": 1527984500000,
    "office": "North Plaza,CA",
    "warranty_type": "WithService",
    "branch": "North America - Plaza",
    "apn_username": "zylker",
    "device_name": "Zylker-Sales-iPad-12",
    "warranty_expiration_date": 1530057600000,
    "registered_time": 1527984000000,
    "name": "Zylker-Sales-iPad-12",
    "purchase_price": "65000",
    "asset_owner": "John Smith",
    "purchase_order_number": "SR2Ik56779",
    "location": "Building 3, Floor 2",
    "area_manager": "Mary Doe",
    "purchase_date": 1527984000000
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

meidstring

Mobile Equipment Identifier

warranty_numberstring

Warranty number

cellular_technologyinteger

Cellular technology type: 1 - None, 2 - GSM, 3 - CDMA

officestring

Office location

apn_usernamestring

APN username

model_namestring

Device model name

warranty_expiration_datelong

Warranty expiration date in milliseconds

purchase_order_numberstring

Purchase order number

modelstring

Device model identifier

purchase_typestring

Purchase type

available_external_capacitystring

Available external storage (GB)

asset_tagstring

Asset tag

available_ram_memoryinteger

Available RAM (MB)

warranty_typestring

Warranty type

product_namestring

Product/manufacturer name

modem_firmware_versionstring

Baseband firmware version

purchase_priceinteger

Purchase price

purchase_datelong

Purchase date in milliseconds

device_capacitystring

Total device capacity (GB)

is_lost_mode_enabledboolean

Whether Lost Mode is enabled

descriptionstring

Device description

managed_device_idlong

Managed device resource identifier

os_namestring

Operating system name (e.g., Android, iOS)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Device details updated successfully

Copied!

  {
    "meid": "SM-G935F",
    "warranty_number": "SJSU64728372",
    "purchase_type": "Reseller",
    "available_external_capacity": "20.47",
    "asset_tag": "TestDevice",
    "cellular_technology": 1,
    "is_lost_mode_enabled": false,
    "description": "Belong to Zylker Inc",
    "available_ram_memory": 983,
    "managed_device_id": 9508000000013120,
    "office": "North Plaza,CA",
    "warranty_type": "WithService",
    "apn_username": "zylker",
    "product_name": "samsung",
    "modem_firmware_version": "10.10.00",
    "model_name": "hero2ltexx",
    "warranty_expiration_date": 1530057600000,
    "purchase_price": 65000,
    "purchase_order_number": "SR2Ik56779",
    "os_name": "Android",
    "model": "SM-G935F",
    "purchase_date": 1527984000000,
    "device_capacity": "24.81"
  }

▼ Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.