Skip to content
merran
GitHubInstall

Merran documentation API & integrations

Change something bought every week

PATCH
/api/list/every-week/{weeklyId}
curl --request PATCH \
--url http://localhost:3000/api/list/every-week/0199e8b0-5a10-7a01-8b00-000000000023 \
--header 'Content-Type: application/json' \
--cookie merran.session_token=<merran.session_token> \
--data '{ "amount": "2 bunches" }'

With an API key, it needs the list: write permission.

weeklyId
required
string

Example

0199e8b0-5a10-7a01-8b00-000000000023
Media typeapplication/json
object
name
string
>= 1 characters <= 200 characters
amount
string | null
<= 60 characters

Example

{
"amount": "2 bunches"
}

Changed.

Media typeapplication/json
object
id
required
string
name
required
string
amount
required
string | null
aisle
required
string | null

Example

{
"id": "0199e8b0-5a10-7a01-8b00-000000000023",
"name": "Bananas",
"amount": "1 bunch",
"aisle": "0199e8b0-5a10-7a01-8b00-000000000020"
}

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."
}
}
}

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."
}
}
}

Not bought every week.

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."
}
}
}

© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.