Skip to main content
PATCH
Update a Fermentable

Authorizations

X-API-Key
string
header
required

An API key created from a signed-in session. See Authentication.

Path Parameters

id
string<uuid>
required

Fermentable id

Body

application/json
name
string

Fermentable name, e.g. "Maris Otter"

Minimum string length: 1
type
enum<string>
default:grain

Fermentable category

Available options:
grain,
sugar,
extract,
dry_extract,
adjunct
amount_kg
number

Weight in kilograms

Required range: x >= 0
color_srm
number | null

Colour in SRM

yield_percent
number | null

Extract yield percentage

sort_order
integer

Display order

Required range: x >= 0

Response

The updated Fermentable

id
string<uuid>
read-only

Unique identifier

recipe_id
string<uuid>
read-only

Parent recipe

name
string

Fermentable name

type
enum<string>

Fermentable category

Available options:
grain,
sugar,
extract,
dry_extract,
adjunct
amount_kg
number

Weight in kilograms

color_srm
number | null

Colour in SRM

yield_percent
number | null

Extract yield percentage

sort_order
integer

Display order

created_at
string<date-time>
read-only

ISO 8601 timestamp