POST/api/recipes/{id}/installs

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
idintegerrequired
Recipe id
device_idintegeroptional
Device whose playlist the install joins
inherit_oauthbooleanoptional
For an oauth_choice recipe: carry the author's OAuth connection

3 status codes
200Installs without a playlist when no device is given
dataobjectoptional
401Unauthorized
errorstringoptional
404Not a published recipe

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Not a published recipe.