Update a Device

• Request Parameters

• Response

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.

JavaScript

Updates a specified device.

Code

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

Output

// void

cURL

Updates a specified device.

Code

curl --include --request POST "https://connect.getseam.com/devices/update" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "ccfab465-4838-4ff3-af62-97c78e8bf44b",
  "name": "My Updated Device",
  "is_managed": true,
  "custom_metadata": {
    "id": "internalId1"
  }
}
EOF

Output

{}

Python

Updates a specified device.

Code

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

Output

None

Ruby

Updates a specified device.

Code

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

Output

nil

PHP

Updates a specified device.

Code

<?php
$seam->devices->update(
    device_id: "ccfab465-4838-4ff3-af62-97c78e8bf44b",
    name: "My Updated Device",
    is_managed: true,
    custom_metadata: ["id" => "internalId1"]
);

Output

null

Seam CLI

Updates a specified device.

Code

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

Output

{}

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

device_id String (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.

---

is_managed Boolean

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

---

name String

Name for the device.

---

properties Object

name String

Name for the device.

---

Response

void