Merran documentation API & integrations
Change what the household always has
PUT
/api/households/current/on-hand
const url = 'http://localhost:3000/api/households/current/on-hand';const options = { method: 'PUT', headers: { cookie: 'merran.session_token=<merran.session_token>', 'Content-Type': 'application/json' }, body: '{"items":["salt","pepper","water","ice","olive oil"]}'};
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/households/current/on-hand \ --header 'Content-Type: application/json' \ --cookie merran.session_token=<merran.session_token> \ --data '{ "items": [ "salt", "pepper", "water", "ice", "olive oil" ] }'Anyone in the household can. Saved tidied: lowercase, without repeats, and “salt and pepper” as salt and pepper. With an API key, it needs the list: write permission.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
items
required
Left off lists made from the plan. Each covers its kinds: “salt” is kosher and sea salt too.
Array<string>
Example
{ "items": [ "salt", "pepper", "water", "ice", "olive oil" ]}Responses
Section titled “Responses”Saved.
Media typeapplication/json
object
items
required
Left off lists made from the plan. Each covers its kinds: “salt” is kosher and sea salt too.
Array<string>
Example
{ "items": [ "salt", "pepper", "water", "ice", "olive oil" ]}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." } }}© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.