Skip to main content
POST
Create a household

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). See the authorization guide.

Scopes

contacts:write

Create, update and delete your contacts and households

Body

application/json
name
string
required
Required string length: 1 - 250
household_type
string | null

A value from GET /household_types. Required when the firm requires it.

Maximum string length: 500
members
object[]

Each contact once.

Response

The created household.

is_external
boolean
required
read-only

True when this record has an active integration link, including an export from Vega. This is current linkage, not historical origin, and is independent of linked contacts or households. Associated records cannot be patched or deleted through this API, except that a meeting may patch reviewed alone. No provider/account details are exposed.

id
string<uuid>
required
name
string
required
household_type
string | null
required

A value from the firm's household types. A household synced from another CRM can carry a value that is not on the list.

members
object[]
required

The members the user can see, by relationship (head first) and then name.

created_on
string<date-time>
required
updated_on
string<date-time>
required
important_information
string | null
required

Read-only client profile content.

financial_planning
string | null
required

Read-only client profile content.

investments
string | null
required

Read-only client profile content.

living_story
string | null
required

Read-only client profile content.

services
string[]
required

Stored firm service values; empty when no services are set.

custom_fields
object[]
required
roles
object[]
required

The firm-defined business role slots. Assignment does not grant access. An empty slot has null user_id and user_label; a former firm user can keep an id with a null label.

Related contacts visible to the connected user. related_to_contacts contains records listing this record.

Related contacts visible to the connected user. related_to_contacts contains records listing this record.

Related households visible to the connected user. related_to_households contains records listing this record.

Related households visible to the connected user. related_to_households contains records listing this record.

owner
object | null
required
creator
object | null
required
client_folder_url
string | null
required