Merran documentation API & integrations
Change the weekly autoplan
const url = 'http://localhost:3000/api/plan/autoplan';const options = { method: 'PUT', headers: { cookie: 'merran.session_token=<merran.session_token>', 'Content-Type': 'application/json' }, body: '{"enabled":true,"day":6,"hour":9,"meals":["dinner"],"addToList":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url http://localhost:3000/api/plan/autoplan \ --header 'Content-Type: application/json' \ --cookie merran.session_token=<merran.session_token> \ --data '{ "enabled": true, "day": 6, "hour": 9, "meals": [ "dinner" ], "addToList": true }'Household admins only. On its day and hour it fills the week ahead’s empty meals the way Fill the week does, saying why for each, and can put what they need on the list. Turning it on plans nothing straight away: it waits for its day and hour. A run that’s late, with the server off, plans what’s left of its week.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
The day it runs, 0 for Sunday, in the household’s time zone.
The hour it runs, 0 to 23, in the household’s time zone.
The meals it fills, of those the household plans.
Whether it puts what the week needs on the list too.
Example
{ "enabled": true, "day": 6, "hour": 9, "meals": [ "dinner" ], "addToList": true}Responses
Section titled “Responses”Saved.
object
The day it runs, 0 for Sunday, in the household’s time zone.
The hour it runs, 0 to 23, in the household’s time zone.
The meals it fills, of those the household plans.
Whether it puts what the week needs on the list too.
When it runs next; none while it’s off.
Example
{ "enabled": true, "day": 6, "hour": 9, "meals": [ "dinner" ], "addToList": true, "next": "2026-10-24T16:00:00.000Z", "last": { "week": "2026-10-19", "at": "2026-10-17T16:00:00.000Z", "planned": 6, "empty": 7, "listed": 18 }}Not signed in.
object
object
object
Example
{ "error": { "code": "not_found", "message": "There's nothing here.", "fields": { "name": "Give it a name." } }}Not allowed.
object
object
object
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.