Install a recipe

Adds the recipe to the account the way getRecipe's install_method says, and to the device playlist when a device_id is given.

post/api/recipes/{id}/installs

Request

Base URL: https://trmnl.com
URL: https://trmnl.com/api/recipes/{id}/installs
Auth: HTTP bearer

Path parameters

idinteger required

Recipe id

Request body

device_idinteger

Device whose playlist the install joins

inherit_oauthboolean

For an oauth_choice recipe: carry the author's OAuth connection

Response

Installs without a playlist when no device is given

Example response

{
  "data": {
    "plugin_setting": {
      "id": 1,
      "name": "My Plugin Setting",
      "description": "Upcoming train departures",
      "plugin_id": 1,
      "refresh_interval": 60,
      "icon_url": "https://trmnl-public.s3.com/qwertyasdf",
      "icon_content_type": "image/png",
      "strategy": "webhook"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.