SMsmartthings
Coordinate

POST /services/coordinate/locations/{locationId}/subscriptions

Create a new subscription

Request

Path parameters

locationIdstring required

A unique location identifier. This is not guaranteed to be a valid UUID.

Headers

Authorizationstring string required

OAuth token

Request body

capabilitiesstring[] required

capability name(s). NOTE: alert cannot be combined with other capabilities

isaIdstring required

InstalledApp ID

postalCodestring

Postal code (This ID is only supported in "alert" capability)

typestring

DIRECT or EXECUTION delivery, default to DIRECT

predicatestring

JEXL formatted expression. See https://commons.apache.org/proper/commons-jexl/reference/syntax.html

Example request

{
  "capabilities": [
    "weather",
    "forecast",
    "airQuality",
    "airQualityForecast"
  ],
  "isaId": "d61126ba-a485-4c6d-8ec4-0d41f5f2757c",
  "type": "EXECUTION",
  "predicate": "now.weather.temperature.value > 20 && now.airQuality.o2Index.value > 1"
}

Response

Success

locationIdstring required

location ID

subscriptionIdstring

subscription ID created

Example response

{
  "locationId": "fb9e719c-e432-4dc3-86b3-7b64ce76c1dc",
  "subscriptionId": "76ba490c-f10d-4746-8f20-f291b327836c"
}

Changes

No recorded changes to this operation across all 8 revisions of this API.