---
title: "Register Thermostat"
method: POST
path: "/buildings/{buildingId}/thermostats"
tags: ["thermostats"]
---

# Register Thermostat

`POST /buildings/{buildingId}/thermostats`

## Request

- Base URL: `https://api.sb.ecobee.com/api/v2`
- URL: `https://api.sb.ecobee.com/api/v2/buildings/{buildingId}/thermostats`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.sb.ecobee.com/api/v2/token` scopes: `create:thermostat`, `read:thermostat`

Registers a thermostat in SmartBuildings in a specific building

## Request body

- object: The unique identifier for a thermostat. ID will match the serial number on the physical thermostat.
  - `thermostatId` string, required: The unique identifier for a thermostat. The ID will match the serial number on the physical thermostat.
  - `isResidentMode` boolean: Indicates whether the thermostat is currently in tenant/resident mode

## Response `201`

Success

- Thermostat
  - `status` 'success'
  - `data` object
    - `buildingId` string
    - `id` string: The unique identifier for a thermostat. The ID will match the serial number on the physical thermostat.
    - `name` string: The name shown in the SmartBuildings web portal or mobile application. This can be set to a different value than what is shown on the thermostat as desired.
    - `thermostatName` string: The name shown on the physical thermostat. This can be set to a different value than what is shown in the SmartBuildings web portal or mobile application as desired.
    - `timeZoneOffsetMinutes` integer: Offset in minutes from GMT
    - `hvacModes` HvacMode[]

## Other responses

- `400`: Bad Request
- `401`: Not authenticated
- `403`: Not authorized
- `404`: Not Found
- `422`: Validation Failed
- `429`: Too Many Requests
- `500`: Internal Server Error
- `default`: Unexpected error

---

[API](https://skmtc.dev/ecobee/apis/ecobee-smartbuildings-public-api.md) - [All operations](https://skmtc.dev/ecobee/apis/ecobee-smartbuildings-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ecobee/apis/ecobee-smartbuildings-public-api/revisions/d78d4fd5e1c6?raw)