Delete a Shopping List

This endpoint allows you to delete any secondary shopping list.

Delete Shopping List

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

You can use the following path parameter to delete a shopping list:

Path Parameters

Name	Type	Description
id	string	The shopping list identifier.

Headers

Name	Type	Description
Authentication	string	User Access token containing shopping_list:write scope to authorize the API usage. For more information, see Authentication.

200 This is how a successful response looks.

{}

400 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 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 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]

To delete your primary shopping list, you must first remove it as your default list.

Sample Request and Response

Curl Request

curl -X DELETE "https://api.whisk.com/list/v2/10659fd8679a1064b5bb4b17e944148753d"
    -H "Accept: application/json" 
    -H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"

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

{}