/
GI
givebutter
/
Givebutter API Documentation
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 4w ago · Updated 4w ago
Details
Campaign Discount Codes
5
Campaign Members
3
Campaign Teams
3
Campaign Tickets
3
Campaigns
5
Contact Activities
5
Contact Tags
3
Contacts
6
Funds
5
Household Contacts
4
Households
5
get
List all households
post
Create a household
get
Get a household
put
Update a household
delete
Delete a household
Messages
2
Payouts
2
Pledges
2
Recurring Plans
2
Tickets
2
Transactions
4
Webhook Activities
2
Webhooks
5
Households
Update a household
put
/v1/households/{household}
Path parameters
household
integer
required
The household ID
Request body
HouseholdUpdateRequest
required
name
string
head_contact_id
integer
nullable
note
string
nullable
envelope_name
string
nullable
Response
App.Http.Resources.API.HouseholdResource
AppHttpResourcesAPIHouseholdResource
required
id
integer
required
name
string
required
head_contact_id
integer
nullable
required
account_id
integer
required
envelope_name
string
nullable
required
note
string
nullable
required
created_at
string
required
updated_at
string
required
contacts
ContactResource[]