For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Home Guides API Reference

API Reference

API Reference collection.v1 DeviceCollectionService

AddDevicesToCollection

||View as Markdown|

Example request

1 {
2   "collection_id": 42,
3   "device_selector": {
4     "selection_type": {
5       "device_list": {
6         "device_identifiers": [
7           "example"
8         ]
9       }
10     }
11   }
12 }

Example response

1 {
2   "collection_id": 42,
3   "added_count": 42
4 }

Adds devices to a collection

AddDevicesToCollectionRequest

Request

This endpoint expects an object.

collection_idlong

ID of the collection to add devices to

device_selectorobject

Devices to add: specific list or all paired devices

AddDevicesToCollectionResponse

Response

This endpoint returns an object.

collection_idlong

ID of the collection devices were added to

added_countinteger

Number of devices successfully added May be less than requested if some devices were already members