Patch Custom Ingredient Metadata
Partially update a custom ingredient's metadata. Send only the fields you want to change; omitted fields stay unchanged. Wires name — rename the ingredient — and approved_markets, a full-list replace of the markets this ingredient participates in, which controls whether it appears in searchIngredients / the browser typeahead for a given market. Allowed while the ingredient is draft or active; rejected once archived.
Path Parameters
Header Parameters
Optimistic-concurrency token. Pass the version_id returned by the previous mutation (or by GET /recipes/{id}/versions) so the server can reject the request when another writer has advanced the recipe in the meantime. A stale token (header present but HEAD has moved) surfaces HTTP 409 with the current version_id in the response body. An absent token on a versioned recipe surfaces HTTP 412. Only consumed on API versions that declare the recipe_versioning capability — older versions ignore the header.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PATCH "https://api.bettermenu.live/studio/custom-ingredients/string/metadata" \ -H "If-Match: string" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"id": "stringstringstringstringst",
"org_id": "stringstringstringstrings",
"status": "draft",
"name": "string",
"entry_method": "form",
"notes": "string",
"reference_amount": "string",
"reference_unit": "string",
"household_measure": "string",
"reference_quantity_g": "string",
"density_g_per_ml": "string",
"nutrients": [
{
"id": "stringstringstringstringst",
"unit": "string",
"amount": "string",
"market_nutrients": {
"property1": {
"bmid": "string",
"nutrient_id": 0
},
"property2": {
"bmid": "string",
"nutrient_id": 0
}
}
}
],
"approved_markets": [
"US"
],
"brand": "string",
"manufacturer": "string",
"source_url": "string",
"attributes": [
{
"key": "string",
"type": "string",
"value": null,
"searchable": false
}
],
"artifacts": [
{
"key": "string",
"kind": "string",
"uploaded_at": "2019-08-24T14:15:22Z"
}
],
"ingredient_statement": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"meta": {
"version": "string",
"request_id": "string",
"timestamp": "string"
},
"version_id": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}