Skip to main content
PATCH
Update recipe

Authorizations

X-API-Key
string
header
required

Path Parameters

recipe_id
string<shortuuid>
required

Id of the recipe.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Payload for PATCH /recipes/{recipe_id}. Only the keys present are applied.

title
string | null

Recipe title.

Required string length: 1 - 200
Pattern: ^[^\x00]{1,200}$
description
string | null

Short description.

Pattern: ^[^\x00]{0,}$
ingredients_list
string | null

Ingredients, one per line.

Minimum string length: 1
Pattern: ^[^\x00]{0,}$
instructions
string | null

Preparation instructions.

Minimum string length: 1
Pattern: ^[^\x00]{0,}$
image_url
string | null

External image URL (http or https).

Maximum string length: 200
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,191})?$
preparation_time_minutes
integer | null

Preparation time in minutes.

Required range: 0 <= x <= 2147483647
cooking_time_minutes
integer | null

Cooking time in minutes.

Required range: 0 <= x <= 2147483647
servings
integer | null

Number of servings the recipe makes.

Required range: 1 <= x <= 2147483647
difficulty
enum<string> | null

How hard the recipe is.

Available options:
easy,
medium,
hard
gtins
string<gtin>[] | null

Replace the set of products the recipe is shown on. Each must be a product the recipe's organization owns, else 404 and nothing changes. Omit to leave the attachments alone.

Maximum array length: 200
Required string length: 8 - 14

Response

OK

A recipe with the products it is attached to.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
organization_id
string<shortuuid>
required

The organization that owns this recipe.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
title
string
required

Recipe title.

description
string
required

Short description. Empty string when unset.

ingredients_list
string
required

Ingredients, one per line.

instructions
string
required

Preparation instructions.

image_url
string
required

External image URL. Empty string when unset.

preparation_time_minutes
integer
required

Preparation time in minutes.

cooking_time_minutes
integer
required

Cooking time in minutes.

servings
integer
required

Number of servings the recipe makes.

difficulty
enum<string>
required

How hard the recipe is to prepare.

Available options:
easy,
medium,
hard
products
RecipeProductOut · object[]
required

The products this recipe is shown on, by GTIN.

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).