Create a Household API by Using Configured Rollup Definitions

Create a Household API Setup to use Connect API calls that retrieve household details and related records without the help of a Salesforce Developer.

Available in: Lightning Experience

Available in: Professional, Enterprise, and Unlimited Editions

User Permissions Needed
To configure Household API Setup:	Financial Services Cloud Extensions
To generate a Data Processing Engine definition for record aggregation:	Record Aggregation Access

From Setup, in the quick find box, enter Household API Setup, then click Household API Setup.
Click New.
Enter an API definition name.
Enter a label.
Select an object.
To roll up details for a household account, select the Account or the Party Relationship Group object. The data rolls up to this object. For example, select the Account object to roll up details related to the household, such as members, financial accounts, assets, and liabilities.
Select the fields from the object to show in the API.
Click Add Rollup Definition.
Select a rollup definition.
The rollup definition defines the data that rolls up to the object.

To refresh rollups in near real-time, turn on On-Demand Record Rollup. A maximum of 5 record rollup definitions per household API setup can be refreshed at one time.

Your rollup definition is configured and the object is automatically populated with the name of the object in the rollup definition.
Select the fields that you want to show in the API, and then save your changes.

Did this article solve your issue?

Let us know so we can improve!

Product Area