Ctrlk
Whisk HomeHelp CenterDeveloper Tools
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update basic details of a Shopping List

This endpoint allows you to update the shopping list name or set/reset it as primary.

Update Shopping List

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

You can use a body parameter to update a shopping list:

Path Parameters

Name
Type
Description

id

string

The shopping list identifier.

Headers

Name
Type
Description

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

Name
Type
Description

body

object

The body object contains the attributes to update the general shopping list details. See the Body Object Example below.

{
  "list": {
    "id": "string",
    "name": "string",
    "primary": true
  }
}
{
  "error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
  "message": "Additional details about error are not static and can be changed"
}
{
  "code": "auth.tokenNotFound"
}
This is unexpected response, something is wrong on our side, please contact: [email protected]

Request Body Object Example

The fields object allows you to specify new values for the shopping list attributes. Currently, we only support updating the name and primary attributes.

The mask object allows you to specify the attributes that you want to update specifically. For example, in each update request, you need to specify values for both name and primary attributes regardless of whether you want to update both or only one of them. Hence, the mask object determines which attributes are to be updated exactly.

The mask object contains the path array that allows you to add a comma-separated list of attributes to update.

Sample Request and Response

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.

A successful response includes the shopping list identifier and its updated attributes.

PreviousDelete a Shopping ListNextMove Items between Shopping Lists

Last updated

Was this helpful?