Coordinate

PUT /services/coordinate/locations/{locationId}/subscriptions/{subscriptionId}

Update a subscription

Request

Base URL
https://api.smartthings.com/v1
Auth
OAuth 2
Implicithttps://auth-global.api.smartthings.com
Scopesr:locations:*, mobile
TypeScript
https://skmtc.dev/smartthings/apis/smartthings-api/docs/services/coordinate/locations/:locationId/subscriptions/:subscriptionId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

locationIdstring required

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

subscriptionIdstring ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ required

The ID of the subscription

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

Changes

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