Household data connections
Household data connections link each of your firm's households to its household record in a connected CRM: Wealthbox, Redtail or Slant. A household's notes, tasks and workflows, and the fields that crm=true fills, come from the record it is linked to. The console shows them on the Household Data Connections page, reached from Connect CRM on the Households tab.
A household can be linked to a record of one CRM only, and a Slant household record to one household only. Linking a household gives it the name of its CRM record. Nothing is written to the CRMs.
To create households from the CRM records no household is linked to, call Create households from unlinked CRM records.
Get the household data connections
Returns your firm's households, archived ones included, each with the CRM household records linked to it, and the household records of each connected CRM, linked or not. `suggested` is always `{}`.
Update household data connections
Links your firm's households to CRM household records, and returns the household data connections as **Get the household data connections** returns them. The request body is keyed by CRM; each value maps a household ID to the ID of the CRM record to link it to. For each CRM you send, your firm's households that you leave out are unlinked from that CRM; CRMs you leave out do not change. A household you link takes the name of its CRM record. A negative household ID, such as `-1`, creates a household from the CRM record; to see it, call **Get the household data connections**. A household can be linked to one CRM only, and a Slant household record to one household only. Nothing is written to the CRMs.
Get suggested household data connections
Returns, for each of your firm's households that is not linked to the CRM in `service`, the unlinked household record of that CRM that matches it, if one does. A record is suggested for one household only. Nothing is linked: to link a household, call **Update household data connections**.
Create households from unlinked CRM records
Creates a household from each household record of the CRM in `service` that no household of your firm is linked to, up to 25 in one request, and links each household to its record. Send `tags` to use only the Wealthbox or Slant records with one of those tags; Redtail records are not filtered. `created` counts the records this request tried, including any whose household could not be created; `remaining` counts the records left for another request.