Change the household

PATCH

/api/households/current

curl --request PATCH \
  --url http://localhost:3000/api/households/current \
  --header 'Content-Type: application/json' \
  --cookie merran.session_token=<merran.session_token> \
  --data '{ "name": "The Rivera-Parks", "weekStartsOn": 1 }'

• Your Merran

Household admins only.

Authorizations

• session

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 100 characters

country

string | null

/^[A-Z]{2}$/

currency

string | null

/^[A-Z]{3}$/

timeZone

string

weekStartsOn

integer

<= 6

meals

The meals filled for it.

Array<string>

>= 1 items

Allowed values: breakfast lunch dinner snack

Example

{
  "name": "The Rivera-Parks",
  "weekStartsOn": 1
}

Responses

200

Changed.

Media typeapplication/json

object

id

required

string

name

required

string

country

required

string | null

currency

required

string | null

timeZone

required

string

weekStartsOn

required

integer

meals

required

The meals filled for it (by Fill the week and Plan each week), in a day’s order: every meal until it opts out of some. Any meal can be planned by hand.

Array<string>

Allowed values: breakfast lunch dinner snack

role

required

string

Allowed values: owner admin member

Example

{
  "id": "0199e8b0-5a10-7a01-8b00-000000000003",
  "name": "The Riveras",
  "country": "US",
  "currency": "USD",
  "timeZone": "America/Phoenix",
  "weekStartsOn": 0,
  "meals": [
    "dinner"
  ],
  "role": "owner"
}

401

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

403

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