Edit Menu Cycle Schedule

Edits an existing menu cycle schedule.

Setting the Update Mode

The update_type field can be used to define the scope of the changes made by a call to this endpoint. These options are possible:

  • ALL - will update the planned recipes of all instances;
  • CURRENT - will update the planned recipes of the current instance;
  • CURRENT_AND_FUTURE - will update the planned recipes of the current instance and of all future instances;
  • FUTURE - will update the planned recipes of all future instances.

This field defaults to ALL if no value is specified.

🚧

The update_type will be ignored in requests that modify a core attribute of a schedule.

Some attributes of a menu cycle schedule are considered its core attributes: start_date, end_date, duration_in_weeks, number_of_cycles, repeat_every_in_weeks

If your request includes any of these fields, the update_type will be ignored, and your changes will be applied to all instances, including planned recipes, regardless of the selected update mode. Proceed with caution!

To avoid unintended changes to recipe planning, it is recommended not to edit these core fields in conjunction with planned recipes.

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!