POST Add Hierarchy Set
URL: /hierarchy/set
Accessible by: EMS, Utility accounts only.
Restrictions: User must have the hierarchy privilege.
Adds a new set to 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 "add". |
setName | 1 | String | Yes | The name of the new set. |
parentPath | 1 | String | Yes | The path to the parent for the new 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/set?format=json POST BODY: { "operation": "add", "setName": "New Set", "parentPath": "/" }
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": "" } }