Sign in
recipes

Update a chef-owned recipe

put/chefs/recipes/{recipe_id}

Path parameters

recipe_idinteger required

Request body

authorstring nullable
calculated_servingsnumber nullable
cc_override_keysstring[] nullable
custom_itemboolean nullable
filter_tagsstring[] nullable
food_namestring nullable
food_name_aliasstring nullable
food_name_alias_translationsobject nullable
food_name_translationsobject nullable
image_urlstring nullable required
instructions_strstring nullable
internal_notesstring nullable
labelstring required
net_serving_size_gnumber nullable
notestring nullable
organizationstring nullable
percent_eatennumber nullable
preparation_method'' | 'homemade' | 'restaurant' | 'cpg' | 'store_bought' | 'other'
raw_data_idnumber
serving_unit_amountnumber nullable
serving_unit_labelstring nullable
serving_unit_label_translationsobject nullable
servingsnumber nullable
tag_override_keysstring[] nullable
urlstring nullable required
visibility'private' | 'public' nullable

Chef/admin recipe audience. Patient recipe endpoints ignore this field and remain private.

yield_amountnumber nullable
yield_unit_labelstring nullable

Example request

{
  "author": "Jane Doe",
  "image_url": "https://example.com",
  "ingredient_groups": [
    {
      "ingredients": [
        {
          "description": "1 cup of milk",
          "food_name": "milk",
          "food_name_alias": "milk",
          "nutrient_overrides": {
            "aa_patient": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "bb_reviewer": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "cc_external": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "dd_estimate": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "ee_validation": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            }
          },
          "serving_unit_amount": "1",
          "serving_unit_label": "cup",
          "servings": "10"
        }
      ],
      "name": "Icing"
    }
  ],
  "ingredients": [
    {
      "description": "1 cup of milk",
      "food_name": "milk",
      "food_name_alias": "milk",
      "nutrient_overrides": {
        "aa_patient": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "bb_reviewer": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "cc_external": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "dd_estimate": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "ee_validation": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        }
      },
      "serving_unit_amount": "1",
      "serving_unit_label": "cup",
      "servings": "10"
    }
  ],
  "label": "Quinoa Salad",
  "nutrient_overrides": {
    "aa_patient": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "bb_reviewer": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "cc_external": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "dd_estimate": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "ee_validation": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    }
  },
  "organization": "Diabetes Canada",
  "url": "https://example.com"
}

Response

successful operation

authorstring nullable
calculated_servingsnumber nullable
calculation_versionstring nullable
cc_override_keysstring[] nullable
chef_idinteger nullable
curation_status'draft' | 'published' | 'archived'
custom_itemboolean nullable
filter_tagsstring[] nullable
food_namestring nullable
food_name_aliasstring nullable
food_name_alias_translationsobject nullable
food_name_translationsobject nullable
forked_from_recipe_idinteger nullable
idnumber required
image_urlstring nullable
ingredientsstring[] required
instructions_strstring nullable
internal_notesstring nullable
labelstring required
label_translationsobject nullable required
net_serving_size_gnumber nullable
notestring nullable
organizationstring nullable
patient_idinteger nullable
percent_eatennumber nullable
preparation_method'' | 'homemade' | 'restaurant' | 'cpg' | 'store_bought' | 'other'
serving_unit_amountnumber nullable
serving_unit_labelstring nullable
serving_unit_label_translationsobject nullable
servingsnumber nullable
source'user' | 'chef' | 'imported' | 'edamam' nullable
tag_override_keysstring[] nullable
unresolved_ingredient_countinteger nullable
urlstring nullable required
visibility'private' | 'public' | 'shared'
yield_amountnumber nullable
yield_unit_labelstring nullable

Example response

{
  "author": "Jane Doe",
  "image_url": "https://example.com",
  "ingredient_groups": [
    {
      "ingredients": [
        {
          "description": "1 cup of milk",
          "food_name": "milk",
          "food_name_alias": "milk",
          "nutrient_overrides": {
            "aa_patient": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "bb_reviewer": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "cc_external": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "dd_estimate": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            },
            "ee_validation": {
              "ontology": {
                "id": 42,
                "levels": [
                  "food"
                ]
              }
            }
          },
          "serving_unit_label": "cup"
        }
      ]
    }
  ],
  "ingredient_responses": [
    {
      "description": "1 cup of milk",
      "food_name": "milk",
      "food_name_alias": "milk",
      "nutrient_overrides": {
        "aa_patient": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "bb_reviewer": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "cc_external": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "dd_estimate": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "ee_validation": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        }
      },
      "serving_unit_label": "cup"
    }
  ],
  "ingredients": [
    "1 cup milk"
  ],
  "instructions_str": "Some instructions",
  "label": "Quinoa Salad",
  "nutrient_overrides": {
    "aa_patient": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "bb_reviewer": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "cc_external": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "dd_estimate": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "ee_validation": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    }
  },
  "organization": "Diabetes Canada",
  "url": "https://example.com"
}

Changes