Merge Device

Merge one or more shadow devices under a primary device

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Merge one or more shadow devices under this primary device. The primary device and each shadow must belong to the same organization. The merge group is capped at four devices (1 primary + up to 3 shadows).

Authorization

This endpoint requires Authorization.

Path Parameters

KeyTypeDescriptionRequired
device_idstringThe primary device ID.Yes

Request Body

KeyTypeDescriptionRequired
with_device_idsarray of stringIDs of devices to merge as shadows under the primary device.Yes

{
	"with_device_ids": ["8f2c1e4a-...", "b71d0a93-..."]
}

Response

Returns { "success": true } on success.

{
	"success": true
}

Errors

StatusExampleMeaning
400with_device_ids must not be emptyThe with_device_ids list was empty.
401Not authorizedMissing or invalid Authorization key.
422merge group would exceed max size 4The resulting merge group would exceed four devices.

Path Params
string
required

The primary device ID.

Body Params
with_device_ids
array of strings
required

IDs of devices to merge as shadows under the primary device.

with_device_ids*
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json