Change the household's settings

PATCH

/api/settings/household

curl --request PATCH \
  --url http://localhost:3000/api/settings/household \
  --header 'Content-Type: application/json' \
  --cookie merran.session_token=<merran.session_token> \
  --data '{ "errorTracking.environment": "home", "errorTracking.dsn": null }'

• Your Merran

Household admins only. Send only what changes. Nothing is saved if anything is wrong.

Authorizations

• session

Request Body^required

Media typeapplication/json

New values by key. Null puts a setting back to its default, and deletes a secret.

object

key

additional properties

Example

{
  "errorTracking.environment": "home",
  "errorTracking.dsn": null
}

Responses

200

Saved.

Media typeapplication/json

No module has household settings yet, so the list is empty.

object

settings

required

Array<object>

object

key

required

string

kind

required

string

Allowed values: text number switch choice list secret json

value

Its value, or null for a secret or a setting that isn’t set.

default

source

required

string

Allowed values: default saved environment

lockedBy

required

The environment variable that sets it, which means it can’t be changed here.

string | null

secret

object

set

required

boolean

hint

required

Its last four characters, when it’s long enough.

string | null

unreadable

required

Sealed with another master key, so it needs entering again.

boolean

choices

Array<string>

Example

{
  "settings": []
}

400

Something isn’t right, field by field.

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

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