Skip to main content
PUT
Update RegisteredDevice
Updates an existing RegisteredDevice record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the RegisteredDevice-Edit role.

Request Body

Required Fields

integer
required
The Id of the RegisteredDevice record to update.
string
required
The name value for this registered device.

Optional Fields

string
The configuration data value for this registered device.
boolean
Whether this registered device is currently active.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the registereddevice was updated successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response