Set Up and Manage Alexa for Residential Devices

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 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.

To set up devices using FFS

  1. Set up the first device (provisioner device) by using the Amazon Alexa app as directed in these device registration steps.

    You must log in to the Alexa app by using the same Amazon Business account that you have registered for use with Alexa for Residential and that you used to purchase your devices.

  2. In the Alexa app, verify that the first device appears online.
  3. After the provisioner device is online, plug in the second device within range of the Wi-Fi router and within Bluetooth range of the provisioner device.
  4. Verify that the second device starts up, it displays the orange setup light, and Alexa says, "Your device is ready for setup. Please follow the instructions in your Alexa App," followed by "Setting up your device."
  5. After the process is complete, the device is online and ready for use as an Alexa for Residential endpoint. You can also use the device as a provisioner for setting up other devices.
  6. 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. For details about homes, see About Alexa for Residential / 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}"
       }
    }
    

Remove 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}