Merran documentation API & integrations
Change something bought every week
PATCH
/api/list/every-week/{weeklyId}
const url = 'http://localhost:3000/api/list/every-week/0199e8b0-5a10-7a01-8b00-000000000023';const options = { method: 'PATCH', headers: { cookie: 'merran.session_token=<merran.session_token>', 'Content-Type': 'application/json' }, body: '{"amount":"2 bunches"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”weeklyId
required
string
Example
0199e8b0-5a10-7a01-8b00-000000000023Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
string
amount
string | null
Example
{ "amount": "2 bunches"}Responses
Section titled “Responses”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.