Recipes

Update a recipe

patch/api/v1/recipes/{id}

Request

  • Base URL: https://spoonjoy.app
  • URL: https://spoonjoy.app/api/v1/recipes/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __session
    • OAuth 2 (authorization code, authorization URL https://spoonjoy.app/oauth/authorize, token URL https://spoonjoy.app/oauth/token, scopes: kitchen:write)

Path parameters

idstring required

Spoonjoy resource id from a previous list response.

Headers

X-Request-Idstring

Optional client-generated request id. Spoonjoy echoes it in X-Request-Id and the REST envelope for logs, retries, and support.

Request body

clientMutationIdstring required
titlestring
descriptionstring nullable
servingsstring nullable
expectedUpdatedAtstring date-time

Optional precondition: the recipe's updatedAt as the client last read it. When given and the recipe has changed since, nothing is updated and the answer is 409 edit_conflict with the current recipe in error.details.recipe. Omit it to update whatever changed in between.

Response

Success

okunknown required
requestIdstring required

Changes

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