Delete Meal

A method to delete a meal from a meal plan.

Deletes all meals within the specified dates. By default, the meals are deleted from the active meal plan, unless a meal_plan_id is specified.

delete
Delete Meals

https://api.whisk.com/mealplan/v2
Request
Response
Request
Body Parameters
period
required
object
An object with from and to dates representing the date range period of meals to be deleted.
meal_plan_id
optional
string
The meal plan identifier from which meals are to be deleted. By default the active meal plan will be used to delete the meals.
generated_only
optional
boolean
Indicates that only automatically generated meals are to be deleted. Default value is false.
Response
200: OK
Upon success, the method returns an empty response.

Sample Request

curl "https://graph.whisk.com/mealplan/v2" \
-H "Accept: application/json" \
-H "Authorization: Token <Access-Token>" \
-d '{
"period": {
"from": {
"year": 2020,
"month": 3,
"day": 10
},
"to": {
"year": 2020,
"month": 3,
"day": 17
}
},
"generated_only": true
}'

Delete Meal from Meal Plan

Removes a single meal from a specified meal plan.

delete
Delete Meal from Meal Plan

https://api.whisk.com/mealplan/v2/meal/:meal_id
Request
Response
Request
Path Parameters
meal_id
required
string
The meal identifier
Body Parameters
meal_plan_id
optional
string
The meal plan identifier
Response
200: OK
Upon successful deletion, the method returns an empty object.
{}

Conflicts resolution

The on_conflict field allows meals to either replace or be inserted into daily meal slots when using the Add Meal or Update Meal endpoints. This helps the meal planner avoid any conflicting actions in case of adding or updating a meal into a daily slot which already is populated with a pre-existing meal.

Here are the following options for the on_conflict field:

  • DAY_SLOT_CONFLICT_ACTION_REPLACE - the new meal will replace the existing one. This is the default option.

  • DAY_SLOT_CONFLICT_ACTION_INSERT - the new meal will be inserted before the existing one, pushing it, along with all following meals, forward one daily slot. However, if you exceed the maximum number of daily meals (7), a 400 error response will be returned.

  • DAY_SLOT_CONFLICT_ACTION_FAIL - the new meal will not be inserted into the daily slot, and a 400 error will be returned.