Update a household
Authorizations
OAuth access token or Slant personal access token (slnt_pat_...). Read-only personal tokens allow GET requests only.
Path Parameters
The household ID
Body
Name of the household
"The Updated Household"
Client tier label (Clients only)
"C-tier"
When the household became a client (Clients only)
"2024-06-01T00:00:00Z"
Custom field values keyed by existing Household field_key. Omitted keys are preserved. Null, blank strings, and empty arrays clear individual values; false is preserved. Unknown field keys are rejected.
Set to Client to promote a Prospect. Other type changes are rejected; the current type is accepted without a transition.
"Client"
Response
successful
The ID of the household
"abc123xyz"
The type of household
Client, Prospect, PastClient "Client"
The name of the household
"The Smith Family"
The ID of the book this household belongs to
"book123xyz"
The people in this household
The tier label for this household (null for Prospects)
"Platinum"
When this household became a client (null for Prospects)
"2024-01-01T00:00:00Z"
URL to the household profile picture
"https://api.slant.app/images/households/abc123xyz"
Custom field values as key-value pairs