Skip to main content
PATCH
Update a household

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

id
string
required

The household ID

Body

application/json
household_name
string

Name of the household

Example:

"The Updated Household"

tier
string

Client tier label (Clients only)

Example:

"C-tier"

became_client_at
string<date-time>

When the household became a client (Clients only)

Example:

"2024-06-01T00:00:00Z"

Response

successful

id
string
required

The ID of the household

Example:

"abc123xyz"

type
enum<string>
required

The type of household

Available options:
Client,
Prospect
Example:

"Client"

name
string
required

The name of the household

Example:

"The Smith Family"

book_id
string
required

The ID of the book this household belongs to

Example:

"book123xyz"

people
object[]
required

The people in this household

tier
string | null

The tier label for this household (null for Prospects)

Example:

"Platinum"

became_client_at
string<date-time> | null

When this household became a client (null for Prospects)

Example:

"2024-01-01T00:00:00Z"

profile_picture_url
string<uri> | null

URL to the household profile picture

Example:

"https://api.example.com/v1/households/abc123xyz/avatar"

custom_fields
object

Custom field values as key-value pairs

Example: