Clear the list

POST

/api/list/clear

curl --request POST \
  --url http://localhost:3000/api/list/clear \
  --header 'Content-Type: application/json' \
  --cookie merran.session_token=<merran.session_token> \
  --data '{ "which": "checked" }'

• Your Merran

Takes off what’s checked, or everything. The answer says what was there, for Undo with /list/restore. With an API key, it needs the list: write permission.

Authorizations

• session
• apiKey

Request Body^required

Media typeapplication/json

object

which

required

What’s checked off, or everything.

string

Allowed values: checked all

Example

{
  "which": "checked"
}

Responses

200

Cleared.

Media typeapplication/json

What the items were before, for Undo with /list/restore.

object

before

required

Array<object>

An item as it was, to put it back (Undo).

object

id

required

string

list

required

string

name

required

string

>= 1 characters <= 200 characters

foodKey

required

string | null

<= 200 characters

quantity

required

number | null

unit

required

string | null

<= 40 characters

amountText

required

string | null

<= 60 characters

aisle

required

string | null

checked

required

boolean

source

required

How it got on the list: from the plan, typed in, every week, a usual buy, or the assistant.

string

Allowed values: plan typed every-week usual assistant

forMeals

required

Array<object> | null

<= 100 items

object

meal

required

string

quantity

required

number | null

unit

required

string | null

createdAt

required

string format: date-time

Example

{
  "before": [
    {
      "id": "0199e8b0-5a10-7a01-8b00-00000000001d",
      "list": "0199e8b0-5a10-7a01-8b00-00000000001c",
      "name": "chicken thighs",
      "foodKey": "chicken thigh",
      "quantity": 3,
      "unit": "pound",
      "amountText": null,
      "aisle": "0199e8b0-5a10-7a01-8b00-000000000021",
      "checked": false,
      "source": "plan",
      "forMeals": [
        {
          "meal": "0199e8b0-5a10-7a01-8b00-00000000001b",
          "quantity": 3,
          "unit": "pound"
        }
      ],
      "createdAt": "2026-10-15T18:30:00.000Z"
    }
  ]
}

401

Not signed in.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

403

Not allowed.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}