SMsmartthings
SmartApps

Update an App

Changed on

Update an app.

put/smartapps/{appNameOrId}

Request

Path parameters

appNameOrIdstring required

The appName or appId field of an app.

Query parameters

signatureType'APP_RSA' | 'ST_PADLOCK'

The Signature Type of the application. For WEBHOOK_SMART_APP only.

requireConfirmationboolean

Override default configuration to use either PING or CONFIRMATION lifecycle. For WEBHOOK_SMART_APP only.

Headers

Authorizationstring string required

OAuth token

Request body

displayNamestring required

A default display name for an app.

descriptionstring required

A default description for an app.

singleInstanceboolean

Inform the installation systems that a particular app can only be installed once within a user's account.

appType'API_ONLY' required

Denotes the type of app. Only API_ONLY is supported.

classificationsAppClassification[] required

An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include:

  • AUTOMATION - Denotes an integration that should display under the "Automation" tab in mobile clients.
  • SERVICE - Denotes an integration that is classified as a "Service".
  • DEVICE - Denotes an integration that should display under the "Device" tab in mobile clients.
  • CONNECTED_SERVICE - Denotes an integration that should display under the "Connected Services" menu in mobile clients.
  • HIDDEN - Denotes an integration that should not display in mobile clients
  • LABS - Denotes an ingration that should display under the "Labs" menu in the modile clients.

Example request

{
  "iconImage": {
    "url": "https://smart-home-monitor.com/image"
  }
}

Response

An app model.

appNamestring ^[a-z0-9.-_]{1,250}$

A user defined unique identifier for an app. It is alpha-numeric, may contain dashes, underscores, periods, and be less then 250 characters long. It must be unique within your account.

appIdstring uuid

A globally unique identifier for an app.

appType'LAMBDA_SMART_APP' | 'WEBHOOK_SMART_APP' | 'API_ONLY'

Denotes the type of app.

principalType'LOCATION' | 'USER_LEVEL' | 'ACCOUNT_LEVEL'

Denotes the principal type to be used with the app. Default is LOCATION.

classificationsAppClassification[]

An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include:

  • AUTOMATION - Denotes an integration that should display under the "Automation" tab in mobile clients.
  • SERVICE - Denotes an integration that is classified as a "Service".
  • DEVICE - Denotes an integration that should display under the "Device" tab in mobile clients.
  • CONNECTED_SERVICE - Denotes an integration that should display under the "Connected Services" menu in mobile clients.
  • HIDDEN - Denotes an integration that should not display in mobile clients
  • LABS - Denotes an ingration that should display under the "Labs" menu in the modile clients.
displayNamestring

A default display name for an app.

descriptionstring

A default description for an app.

singleInstanceboolean

Inform the installation systems that a particular app can only be installed once within a user's account.

installMetadataobject

System generated metadata that impacts eligibility requirements around installing an App.

createdDatestring date-time

A UTC ISO-8601 Date-Time String

lastUpdatedDatestring date-time

A UTC ISO-8601 Date-Time String

Example response

{
  "appName": "security-home-monitor",
  "appId": "c71b0a5b-7dab-41fe-b75f-7cf30246468e",
  "appType": "WEBHOOK_SMART_APP",
  "classifications": [
    "AUTOMATION"
  ],
  "displayName": "Security Home Monitor",
  "description": "An intergration that leverages all security devices in your home - cameras, motion sensors, etc to provide\nyou with peace of mind and #security.\n",
  "iconImage": {
    "url": "https://smart-home-monitor.com/image"
  },
  "installMetadata": {
    "certified": "true",
    "maxInstalls": "-1"
  },
  "owner": {
    "ownerType": "USER",
    "ownerId": "3f178632-79ed-4358-94de-280dbd7c206c"
  },
  "webhookSmartApp": {
    "targetUrl": "https://securityhome.com/smartthings",
    "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlz00iTNPXIo+RM8n0Eudnh84XDWBFAkR\nL7mkOtXvZiKViCR1qs5LT3SaNy62hkUroexCoii4vjRTSHaQ9FwyBRo98EY9U3qzWmr9Row9ONcQ\nVKFVX6qiwb9SZG7QvHSfqVAuWhMGb1fFGUWl94L7kY0CihF+WJS5fdhXc1h/f/tY1439hruL3+BR\n/idfYjAKDa1+euW4b0HKMi4BdJutL/G5FXjDP7MP5fTRuM52erKpON1pwPD8ow/03MhK4wRikHqS\n/Kvd3UnQ8Q7OSrfJevqR0CqBf83Am1HSHh/bqOfsG0epl+2I1RKLBzB2tSTvMfk0ftiRSq/fRrhl\nxsJmFQIDAQAB\n-----END PUBLIC KEY-----\n"
  },
  "createdDate": "2017-05-19T12:39:37Z",
  "lastUpdatedDate": "2017-05-19T12:39:37Z"
}

Changes