Skip to main content
PATCH
/
v1
/
households
/
{id}
Update a household
curl --request PATCH \
  --url https://api.slant.app/v1/households/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "household_name": "The Updated Household",
  "tier": "C-tier",
  "became_client_at": "2024-06-01T00:00:00Z"
}
'
{
  "id": "abc123xyz",
  "type": "Client",
  "name": "The Smith Family",
  "book_id": "book123xyz",
  "people": [
    {
      "id": "abc123xyz",
      "book_id": "book123xyz",
      "first_name": "John",
      "last_name": "Doe",
      "household_id": "xyz789abc",
      "contact_id": "cnt456def",
      "role_type": "client",
      "middle_name": "Robert",
      "salutation": "Mr.",
      "suffix": "Jr.",
      "maiden_name": "Smith",
      "gender": "male",
      "designations": "CPA, CFP",
      "household_role": "head_of_household",
      "preferred_name": "Johnny",
      "date_of_birth": "1985-06-15",
      "job_title": "Software Engineer",
      "ssn": "***-**-6789",
      "drivers_license_number": "******7890",
      "email_addresses": [
        {
          "email": "john.doe@example.com",
          "email_type": "personal",
          "is_primary": true
        }
      ],
      "phone_numbers": [
        {
          "phone_number": "+15555551234",
          "phone_type": "mobile",
          "is_primary": true
        }
      ],
      "addresses": [
        {
          "address_type": "home",
          "is_primary": true,
          "line1": "123 Main St",
          "line2": "Apt 4B",
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country_code": "US"
        }
      ],
      "employments": [
        {
          "business_name": "Acme Corp",
          "id": "emp123xyz",
          "person_id": "abc123xyz",
          "role": "Software Engineer",
          "start_date": "2023-01-15",
          "end_date": "2024-12-31",
          "actively_employed": true
        }
      ],
      "custom_fields": {
        "preferred_contact_method": "Email",
        "risk_tolerance": "Moderate"
      }
    }
  ],
  "tier": "Platinum",
  "became_client_at": "2024-01-01T00:00:00Z",
  "profile_picture_url": "https://api.example.com/v1/households/abc123xyz/avatar",
  "custom_fields": {
    "pageport_lead_source": "Landing Page",
    "industry": "Technology"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.slant.app/llms.txt

Use this file to discover all available pages before exploring further.

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:
{
  "pageport_lead_source": "Landing Page",
  "industry": "Technology"
}