Skip to main content
PATCH
Describe a user's household

Authorizations

x-api-key
string
header
required

Your consumer API key.

Query Parameters

user_id
string
required

Your internal user ID.

Body

application/json

Nothing is required: a PATCH names the fields it changes, the rest keep their value, and a field sent as null is cleared.

location
Location · object | null
owner
Owner · object | null

Response

The household as it now stands.

location
Location · object
required
owner
Owner · object
required