---
title: "Generates plugin launch data."
method: PUT
path: "/smartapps/ui/generate"
tags: ["SmartApps"]
---

# Generates plugin launch data.

`PUT /smartapps/ui/generate`

## Request

- Base URL: `https://api.smartthings.com/v1`
- URL: `https://api.smartthings.com/v1/smartapps/ui/generate`
- Auth: one of:
  - OAuth 2
    - Implicit: `https://auth-global.api.smartthings.com`
    - Scopes: `mobile`
  - OAuth 2
    - Implicit: `https://auth-global.api.smartthings.com`
    - Scopes: `service`
- TypeScript: <https://skmtc.dev/smartthings/apis/smartthings-api/docs/smartapps/ui/generate/put.ts> (a function with typed inputs; its response is checked against the schema)

Generates the plugin data that will be used by the launching client.

## Headers

- `Authorization` string, string, required

## Request body

- LaunchPluginRequest: A request for plugin launch data
  - `appId` string, uuid: A globally unique identifier for an app.
  - `installedAppId` string, uuid: A globally unique identifier for an installed app.
  - `clientParameters` object: The http query parameters to be added to the generated response url

## Response `200`

A launch plugin response model.

- LaunchPluginResponse: A response containing the plugin launch http request data
  - `url` string, uri: The url to launch the plugin ui
  - `method` string: The http method for invoking the url
  - `headers` object: The http headers to be added when invoking the url

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Entity
- `429`: Too many requests
- `default`: Unexpected error

## Changes

- **2026-11-07** `2788a4236800`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smartthings/apis/smartthings-api/changes/smartapps/ui/generate/put.md)

---

[API](https://skmtc.dev/smartthings/apis/smartthings-api.md) - [All operations](https://skmtc.dev/smartthings/apis/smartthings-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartthings/apis/smartthings-api/revisions/2788a4236800?raw)