Set Up and Manage Alexa Smart Properties for Residential Devices

Note: Sign in to the developer console to build or publish your skill.

Important: Currently Alexa Smart Properties for residential supports only Alexa Echo devices that you purchase from the same Amazon Business account that you have registered for use with Alexa Smart Properties for residential. You can purchase devices from other retailers, but you need to set up these devices individually by using the Alexa app for devices without screens, or by using the on-screen instructions for devices with screens.

An Alexa Smart Properties for residential endpoint is a device that is owned by a solution integrator or property owner, who manages it on behalf of home residents.

Supported devices

You can use the following Amazon Echo devices with Alexa Smart Properties for residential:

Amazon Echo (2^nd, 3^rd, 4^th Generation)
Amazon Echo Dot (2^nd, 3^rd, 4^th, 5^th Generation)
Amazon Echo Dot with Clock (3^rd, 4^th, 5^th Generation)
Amazon Echo Plus (2^nd Generation)
Amazon Echo Show 5 (1^st, 2^nd Generation)
Amazon Echo Show 8 (1^st, 2^nd Generation)

Set up devices as endpoints

Alexa Smart Properties for residential supports the use of Frustration-Free Setup (FFS), which enables you to more easily set up multiple Alexa devices by using a provisioner device. You manually set up provisioner device, and then copy its settings to your other devices that need setup. For more information, see Understanding Frustration-Free Setup.

Note: FFS is only available for public service set identifiers (SSIDs) (network IDs).

To set up devices using FFS

Set up the first device (provisioner device) by using the Alexa app. For details, see Set Up Your Echo for devices without screens and Set Up Your Echo Show for devices with screens. You must log in to the Alexa app by using the same Amazon Business account that you have registered for use with Alexa Smart Properties for residential and that you used to purchase your devices.
Important: During initial provisioner device setup, make sure to select the checkbox to store Wi-Fi credentials in your Amazon Wi-Fi locker.
In the Alexa app, verify that the first device appears online.
After the Alexa app shows that the first device is online, plug in the second device within range of the Wi-Fi router that you used to set up the provisioner device. Make sure that you plug in the second device within Bluetooth range of the provisioner device that you set up in step 1.
Important: Make sure that the router is the same router you used for the provisioner device.
Verify that the second device boots up, show the orange set-up light, and say "Your device is ready for setup, please follow the instructions in your Alexa app" followed by "Setting up your device."
After the process is complete, the device is online and ready for use as an Alexa Smart Properties for residential endpoint. You can also use the device as a provisioner for setting up other devices.
You can repeat this process for additional devices, with each device that has been provisioned acting as a provisioner for a new device.

Manage endpoints

Once you have set up your Alexa devices as endpoints, you can associate them with homes. For details about homes, see About Alexa Smart Properties for Residential / Homes.

Associate an endpoint with a home

To associate an endpoint with a home

Create a home, and store the ID for future use.
```
POST /enterprise/residential/v1/homes
```
Enumerate endpoints to obtain the endpoint ID of the device to associate with a home.
```
GET /v2/endpoints?owner=~caller
```

Associate the endpoint with the home by passing in the ID of the home from step 1.

POST /v2/endpoints/{endpointID}/associatedUnits

{
   "associatedUnit": {
      "id": "amzn1.alexa.unit.did.{id}"
   }
}

Remove an endpoint from a home

To remove an endpoint from a home, use the Endpoint API.

To remove an endpoint from a home

Enumerate the endpoints for a home to obtain the endpointID of the device to remove, passing in the ID of the home as unitId.
```
GET /v2/endpoints?associatedUnits.id={unitId}
```
Remove the endpoint from the home by the deleting its association with the home.
```
DELETE* */v2/endpoints/{endpointID}/associatedUnits/{unitId}
```

Was this page helpful?

Provide feedback

Last updated: Mar 29, 2023