POST Move Hierarchy Thermostat

URL: /hierarchy/thermostat

Accessible by: EMS, Utility accounts only.

Restrictions: User must have the hierarchy privilege on the source and destination sets.

Moves thermostats between hierarchy sets. A thermostat may only reside inside a single set. Users may be moved in and out of the Unassigned set.

To force move thermostats irrespective of their current location use the assign thermostat operation.

See Getting Started with Management Set Hierarchy for additional information.

Request Properties

Property	Version	Type	Required	Description
operation	1	String	Yes	The type of request. Always "move".
setPath	1	String	Yes	The set path the thermostats are being moved from.
toPath	1	String	Yes	The set path the thermostats are being moved to.
thermostats	1	String	No	Comma separated list of thermostat identifiers. The thermostats must reside in the from set. If this property is not provided, all thermostats will be moved which reside in the from set.

Response Properties

Property	Version	Type	Description
status	1	Status	The api response code.

Example Request:

Request Body

NOTE: Request body is not encoded for example purposes.

HEADERS:
	Content-Type: application/json;charset=UTF-8
	Authorization: Bearer Rc7JE8P7XUgSCPogLOx2VLMfITqQQrjg
	
REQUEST:
	POST https://api.ecobee.com/1/hierarchy/thermostat?format=json
	
POST BODY:
{
	"operation": "move",
	"setPath": "/MainNode",
	"toPath": "/OtherNode",
	"thermostats": "123456789012,123456789013"
}
				

Sample API Call

curl -s --request POST --data-urlencode @json.txt -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer ACCESS_TOKEN" "https://api.ecobee.com/1/hierarchy/thermostat?format=json"  
				

					
$.get('json.txt', function(jsonData) {
	alert(JSON.stringify(jsonData));
   $.ajax({
   		beforeSend: function(request) {
        	request.setRequestHeader("Authorization", "Bearer ".concat(ACCESS_TOKEN));
    	},
		type: 'post',
		url: 'https://api.ecobee.com/1/hierarchy/thermostat?format=json',
		dataType: 'json',
		contentType: 'application/json',
		data: JSON.stringify(jsonData),
		success: function (data) {
	   		var response = JSON.stringify(data, null, 4);
	    }
	});
});
				

Example Response:

{
    "status": {
        "code": 0,
        "message": ""
    }
}
    

Back To Top