Update a Device

Updates a specified device.

You can add or change custom metadata for a device, change the device’s name, or convert a managed device to unmanaged.

POST /devices/update

JavaScript

Seam SDK

await seam.devices.update({
  device_id: "ccfab465-4838-4ff3-af62-97c78e8bf44b",
  name: "My Updated Device",
  is_managed: true,
  custom_metadata: { id: "internalId1" },
});

/*
// void
*/

200

{
  "ok": true
}

Authorizations

api_keypat_with_workspaceconsole_session_with_workspaceclient_sessionclient_session_with_customer

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

device_id · string<uuid> · required

ID of the device that you want to update.

custom_metadata · object

Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. Adding custom metadata to a device enables you to store custom information, like customer details or internal IDs from your application. Then, you can filter devices by the desired metadata.

Show child attributes

is_managed · boolean · default: true

Indicates whether the device is managed. To unmanage a device, set is_managed to false.

name · string | null

Name for the device.

properties · object

Show child attributes

Response

200

application/json

OK

ok · boolean · required