Skip to main content
PUT
Update a household

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

household
integer
required

The household ID

Body

application/json
name
string
Maximum string length: 255
head_contact_id
integer | null
note
string | null
envelope_name
string | null
Maximum string length: 255

Response

App.Http.Resources.API.HouseholdResource

id
integer
required
name
string
required
head_contact_id
integer | null
required
account_id
integer
required
envelope_name
string | null
required
note
string | null
required
created_at
string
required
updated_at
string
required
contacts
ContactResource · object[]