Developer API Reference

Update a Location

Update a location's homeAway mode

PUT /v1/locations/{locationId}

Body Parameters

homeAway string required
Desired mode at the location. Should either be home or away

Response Body

locationId string
Unique location identifier
name string
The location name
homeAway string
Desired mode at the location. Can be either home or away
devices array
A list of all the devices installed at the location
alerts array
A list of all the current active alerts for the location
subscriptionIds array
A list of all ids of the subscriptions to this location
PUT /v1/locations/{locationId} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {}
{
  "homeAway":"home"
}

{
    "locationId": "ae926a02...dbc8",
    "name": "The Condo",
    "homeAway": "home",
    "devices": [{
          "deviceId": "dac6955c...b96b",
          "type": "monitor",
          "connected": true,
          "calibrated": true
      }],
    "alerts": [{
        "deviceId": "dac6955c...b96b",
        "type": "lowLeak",
        "active": true,
        "startTime": 1514374617,
        "detectedTime": 1514374917,
        "stopTime": 0
    }, {
        "deviceId": "dac6955c...b96b",
        "type": "ambientTemp",
        "active": true,
        "startTime": 1514373460,
        "detectedTime": 1514373760,
        "stopTime": 0
    }],
    "subscriptionIds": ["8402255b...9302"]
}