POST Rename Hierarchy Set

URL: /hierarchy/set

Accessible by: EMS, Utility accounts only.

Restrictions: User must have the hierarchy privilege.

Renames a set in the hierarchy.

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 "rename".
setPath 1 String Yes The path of the set to rename.
newName 1 String Yes The new name to assign. Must be unique to that parent.

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/set?format=json
	
POST BODY:
{
	"operation": "rename",
	"newName": "RenamedNode",
	"setPath": "/ToRename"
}
				

Sample API Call

Show code sample in:
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/set?format=json"  
				

Example Response:

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

Back To Top