Clear Items from a Shopping List

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

delete
Clear Items

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:
Request
Response
Request
Path Parameters
id
required
string
The unique identifier of the list that contains the items to be cleared.
Headers
Authentication
required
string
Server Token or a User Access token containing shopping_list:write scope to authorize the API usage. For more information, see Authentication.
Body Parameters
body
required
object
The body object contains an attribute to indicate which items are to be cleared. See the Body Object Example below.
Response
200: OK
This is how a successful response looks.
{}
400: Bad Request
This failed response appears when error codes are found in the endpoint query.
{
"error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
"message": "Additional details about error are not static and can be changed"
}
401: Unauthorized
This failed response appears due to API authentication failure. The possible error codes that may appear are: auth.tokenNotFound , auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.
{
"code": "auth.tokenNotFound"
}
500: Internal Server Error
This failed response appears when something is not right on Whisk's end. Please send a message to [email protected], and be sure to include both the Request and Response data. We’ll get back to you soon.
This is unexpected response, something is wrong on our side, please contact: [email protected]

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 Request
Response
Curl Request
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.

Response
{}