---
title: "Update Resident Mode on a Thermostat"
method: PATCH
path: "/thermostats/{thermostatId}/residentMode"
tags: ["thermostats"]
---

# Update Resident Mode on a Thermostat

`PATCH /thermostats/{thermostatId}/residentMode`

## Request

- Base URL: `https://api.sb.ecobee.com/api/v2`
- URL: `https://api.sb.ecobee.com/api/v2/thermostats/{thermostatId}/residentMode`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.sb.ecobee.com/api/v2/token` scopes: `write:tenantmode`

Turns resident mode on or off on a thermostat. For more information on resident mode please see https://docs.sb.ecobee.com/v2.0.0/docs/resident-mode#/

## Request body

- ResidentModeRequestBody
  - `isResidentMode` boolean, required: Indicates whether the thermostat is currently in tenant/resident mode

## Response `204`

Success

## Other responses

- `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)