Clear Items from a Shopping List

This endpoint allows you to remove items from a shopping list.

Clear Items

DELETE https://api.whisk.com/list/v2/{id}/item

You can use the following path parameter and a body parameter to clear items from a shopping list:

Path Parameters

NameTypeDescription

id

string

The unique identifier of the list that contains the items to be cleared.

Headers

NameTypeDescription

Authentication

string

Server Token or a User Access token containing shopping_list:write scope to authorize the API usage. For more information, see Authentication.

Request Body

NameTypeDescription

body

object

The body object contains an attribute to indicate which items are to be cleared. See the Body Object Example below.

{}

Request Body Object Example

{
  "only_checked": false
}

only_checked

This boolean attribute allows you to indicate to remove only checked items from the list by setting it to true or all items from the list by setting it to false.

Sample Request and Response

curl -X DELETE "https://api.whisk.com/list/v2/106e1fa4cbb7c844458be372c3e0f7bfa94/item"
    -H "Accept: application/json"
    -H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"
    -d "{ \"only_checked\": false}"

Whisk allows you to discover and understand its API capabilities on the Swagger interface with the ability to try out the API calls directly in your browser. You can call this endpoint here.

Last updated