Skip to main content
PATCH
/
v1
/
devices
/
{id}
Update a device by id
curl --request PATCH \
  --url https://managexrapi.com/v1/devices/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Device_123",
  "configurationId": "AKDJF139UGNLA12J",
  "notes": "This device was recently moved on 9/15",
  "tagIds": [
    "KADJFL2U4T",
    "AKLU32OI2QU5U"
  ]
}
'
{
  "statusCode": 403,
  "message": "Forbidden",
  "error": "ManageXR Error"
}

Authorizations

​
Authorization
string
header
required

API key based authentication where is the Base64 encoding of API_KEY_ID:API_KEY_SECRET

  • Username: The API Key ID.
  • Password: The API Key Secret.

Path Parameters

​
id
string
required

Unique identifier (serial number) of the device

Query Parameters

​
organizationId
string

Unique identifier of the organization. This parameter is only necessary when using multi-organization API keys.

Defaults to the organizationId associated with the API key.

Body

application/json
​
name
string

Name of the device

Example:

"Device_123"

​
configurationId
string

ID of new configuration to assign to the device

Example:

"AKDJF139UGNLA12J"

​
notes
string

Device notes

Example:

"This device was recently moved on 9/15"

​
tagIds
string[]

Ids of tags to apply to device

Example:
["KADJFL2U4T", "AKLU32OI2QU5U"]

Response

Success