Alexa for Residential Device Purchase and Setup

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

Set up devices as endpoints

Alexa for Residential supports the use of Frustration-Free Setup (FFS), which enables you to set up multiple Alexa devices by using a provisioner device. A provisioner device is a manually set up device from which you can copy the settings to your other devices needing setup. For more information, see Understanding Frustration-Free Setup.

To set up devices using FFS, perform the following steps:

  1. Set up the first device (provisioner device) using the Alexa companion app as directed in these device registration steps. You must log in to the Alexa companion app using the same Amazon Business account that you have registered for use with Alexa for Residential and that purchased your devices.
  2. Once the first device is online and shows in the Alexa companion app as online, plug in the second device within the range of the Wi-Fi router. that you used to set up the provisioner device and within Bluetooth range of the provisioner device that you set up in step 1.
  3. The second device should boot up, show the orange setup light, and say "Your device is ready for setup, please follow the instructions in your Alexa App," followed by "Setting up your device."
  4. Once the process is complete, the device is online and ready for use as an Alexa for Residential endpoint. It can also act as a provisioner for setting up other devices.
  5. You can repeat this process for more 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.

Associate an endpoint with a home

To associate an endpoint with a home:

  1. Create a home, and store the ID for future use.
    POST /enterprise/residential/v1/homes
    
  2. Enumerate endpoints to obtain the endpoint ID of the device to associate with a home.
    GET /v2/endpoints?owner=~caller
    
  3. 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}"
       }
    }
    

Removing an endpoint from a home

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

To remove an endpoint from a home:

  1. 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}
    
  2. Remove the endpoint from the home by the deleting its association with the home.
    DELETE* */v2/endpoints/{endpointID}/associatedUnits/{unitId}