Skip to content
Exhale

Change household preferences

POST
/api/v1/household
curl --request POST \
  --url http://127.0.0.1:8484/api/v1/household \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "confirmEveryDays": 1, "confirmTimes": 1, "currency": "example", "dryRun": true, "locale": "example", "name": "example", "payday": 1, "reminderTime": "example", "timezone": "example" }'

Changes the display currency (totals convert into it), time zone, reminder language, name, or default reminder time (HH:MM). Owners only. Also how often an unanswered “was it charged?” is asked again (confirmTimes, confirmEveryDays).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
confirmEveryDays
integer format: int64
>= 1 <= 30
confirmTimes
integer format: int64
>= 1 <= 10
currency
string
dryRun
boolean
locale
string
name
string
<= 60 characters
payday
integer format: int64
<= 31
reminderTime
string
timezone
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
categories
required
Array<object> | null
object
color
string
householdId
required
string
id
required
string
name
required
string
household
required
object
confirmEveryDays
required
integer format: int64
confirmTimes
required
integer format: int64
currency
required
string
id
required
string
locale
required
string
name
required
string
payday
integer format: int64
reminderHour
required
integer format: int64
reminderMinute
required
integer format: int64
timezone
required
string
members
required
Array<object> | null
object
email
string
householdId
required
string
id
required
string
locale
string
name
required
string
role
required
string
paymentMethods
required
Array<object> | null
object
expiresOn
string
householdId
required
string
id
required
string
kind
required
string
last4
string
name
required
string
ownerId
string
tags
required
Array<object> | null
object
name
required
string
subscriptions
required
integer format: int64
today
required
string

Example 

{
  "$schema": "https://example.com/api/schemas/HouseholdInfo.json"
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}