View as Markdown
Wealthbox icon

Wealthbox ACTION

Add Member To Household

Add an existing contact as a member of an existing household via POST /households/{household_id}/members. Run List Households to find household ids and List Contact Options to find contact ids. Example: add contact 67890 as Spouse to household 12345; returns the household object including id and a members array, each member with id, first_name, last_name, title, and type. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Wealthbox account once, then configure and run Add Member To Household from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "wealthbox-add-member-to-household",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    wealthbox: { authProvisionId: "apn_xxxxxxx" },
    householdId: "Household ID",
    contactId: "Contact",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Add Member To Household inputs
Property Type Description
householdId Household ID string
Free-form id of the household to add the member to. Run List Households first to obtain valid ids. Example: 12345.
Required
contactId Contact string
The numeric ID of the contact. Use Find Contact to search by name, email, or phone, or List Contact Options to browse all contacts and retrieve their IDs. Example: 67890.
Required Dynamic
title Title string
The member's role in the household. One of: Head, Spouse, Partner, Child, Grandchild, Parent, Grandparent, Sibling, Other Dependent.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
wealthbox-add-member-to-household
Version
0.0.2
App
Wealthbox
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes