Create Menu Cycle Schedule

post

https://api.apicbase.com/api/v2/menu_planning/menu_cycle_schedule/

Creates a new instance of a menu cycle schedule.

Body Params

name

string

required

The name of the menu cycle schedule. The max length is 100 characters.

start_date

date

required

The start date of the menu cycle schedule.

duration_in_weeks

int32

required

The duration of the menu cycle schedule in weeks. Must be between 1 and 15.

number_of_cycles

int32

required

The number of cycles in the menu cycle schedule. Must be between 1 and 100. It's required if end_date is not provided.

end_date

date

The end date of the menu cycle schedule. It's required if number_of_cycles is not provided.

repeat_every_in_weeks

int32

The number of weeks between each cycle start date. If not provided, each cycle will start after the end of the previous cycle. Must be between 1 and 16.

status

string

enum

Defaults to Draft

The status of the menu cycle schedule

Allowed:

description

string

The description of the menu cycle schedule. The max length is 255 characters.

outlets

array of strings

required

A list of outlet IDs to be linked to the menu cycle schedule.

outlets*

courses

array of objects

required

The courses and planned recipes of the menu cycle schedule.

courses*

custom_fields

json

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400