Adding Custom Metadata to a Device

You can add or change custom metadata for a device.

You can use custom metadata to store a custom payload or object, tailored to the specific needs of your app. For example, this feature is useful for tracking customer information, internal user IDs, or other internal resources for a device. Storing custom metadata in a Seam device object enables you to look up an internal resource from directly within your Seam workspace. Then, you can filter devices by the desired metadata.

Use the Update Device method with the optional custom_metadata property to change or add custom metadata for the connected account. This property accepts up to 50 JSON key:value pairs.

Python

Request:

device_update = seam.devices.update(
    device = "30fd243b-3054-4384-a713-5487076a3826",
    custom_metadata = {
        "internal_account_id": "user-1"
    }
)

pprint(device_update)

Response:

True

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/devices/update' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "device_id": "30fd243b-3054-4384-a713-5487076a3826",
  "custom_metadata": {
    "id": "internal_id_1"
  }
}'

Response:

{
  "ok": true
}

JavaScript

Request:

const deviceUpdate = await seam.devices.update({
  device_id: "30fd243b-3054-4384-a713-5487076a3826",
  custom_metadata: {
    "internal_account_id": "user-1"
  }
})

console.log(deviceUpdate)

Response:

{ ok: true }

Ruby

Request:

device_update = client.devices.update(
  device_id: "30fd243b-3054-4384-a713-5487076a3826",
  custom_metadata: {
    "internal_account_id": "user-1"
  }
)

puts device_update.inspect

Response:

{"ok"=>true}

PHP

Request:

$device_update = $seam->devices->update(
  device_id: "30fd243b-3054-4384-a713-5487076a3826",
  custom_metadata: array('internal_account_id' => 'user-1')
)
echo json_encode($device_update, JSON_PRETTY_PRINT);

Response:

true

C#

Request:

var customMetadata = new Dictionary<string, string>()
{
  {"internal_account_id", "user-1"}
};

var deviceUpdate = seam.Devices.Update(
  deviceId: "30fd243b-3054-4384-a713-5487076a3826",
  customMetadata: customMetadata
);

Console.WriteLine(deviceUpdate);

Response:

{
  "device_id": "30fd243b-3054-4384-a713-5487076a3826",
  "device_type": "schlage_lock",
  ...
  "is_managed": true,
  "custom_metadata": {"internal_account_id"=>"user-1"}
}

Java

Request:

Map<String, CustomMetadataValue> customMetadata =
    Map.of("internal_account_id", CustomMetadataValue.of(Optional.of("user-1")));

seam.devices().update(DevicesUpdateRequest.builder()
        .deviceId("30fd243b-3054-4384-a713-5487076a3826")
        .custom_metadata(customMetadata)
        .build());

Response:

true

Go

Request:

deviceUpdate, err := client.Devices.Update(
	context.Background(),
	&api.DevicesUpdateRequest{
		DeviceId: "30fd243b-3054-4384-a713-5487076a3826",
		CustomMetadata: {"internal_account_id":"user-1"},
	},
)
if err != nil {
	return err
}
fmt.Println(deviceUpdate)
return nil

Response:

true