Update a device

Update a device by the given id.

put

Path parameters

idstringRequired

The id of the device.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class provides the Device Update Request Dto.

namestring · min: 1Required

The name of the device.

phoneNumberstring | nullableOptional

The phone number of the device.

avatarURLstring · uri | nullableOptional

The avatar URL of the device.

tagsstring | nullableOptional

The tags of the device.

statusstring · enumOptional

Represents the status of a device within the system.

Possible values:

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/devices/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "name": "text",
  "phoneNumber": "text",
  "avatarURL": "https://example.com",
  "tags": "text",
  "status": "Inactive"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "type": "Web",
    "code": "XYZ123",
    "isMobileApp": true,
    "tags": "android, smartphone",
    "status": "Active",
    "isDefault": true,
    "testMode": false,
    "name": "John's Phone",
    "phoneNumber": "[phone]",
    "osDevice": "Android",
    "appVersionNumber": "1.0.5",
    "iccid": "89148000000000000001",
    "imsi": "310260000000000",
    "imei": "356938035643809",
    "simCardInfo": "Verizon SIM",
    "avatarURL": null,
    "modifiedDate": "2025-09-19T04:20:20.297437Z"
  },
  "errors": []
}