updateHousehold
# updateHousehold
PATCH
/household
const url = 'http://localhost:8080/api/v1/household';const options = { method: 'PATCH', headers: {cookie: 'hs_session=<hs_session>', 'Content-Type': 'application/json'}, body: '{"name":"example","defaultLocale":"en"}'};
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:8080/api/v1/household \ --header 'Content-Type: application/json' \ --cookie hs_session=<hs_session> \ --data '{ "name": "example", "defaultLocale": "en" }'Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
string
defaultLocale
string
Responses
Section titled “Responses”Updated.
Media typeapplication/json
object
id
required
string
name
required
string
defaultLocale
required
string
memberCount
required
integer
baseUrl
required
string format: uri
createdAt
required
string format: date-time
Examples
Exampleseed
Derived from fixtures/seed.json.
{ "baseUrl": "http://localhost:5173", "createdAt": "2026-09-17T09:00:00.000Z", "defaultLocale": "th", "id": "hh_01j9vd2c703tt6a613pxhc9s0s", "memberCount": 3, "name": "The Wongs' Homestead"}