Household Account Snapshot Response

Output representation of the profile information for an account, including the account type and the requested primary member and account field details.

JSON Example

1{
2  "accountId": "001RO000002Kn4BYAS",
3  "accountType": "HOUSEHOLD",
4  "primaryMemberId": "001RO000002Kn5CZAT",
5  "primaryMemberData": [
6    {
7      "fieldApiName": "Name",
8      "dataType": "String",
9      "label": "Name",
10      "value": "Jane Smith",
11      "metadata": null
12    }
13  ],
14  "accountData": [
15    {
16      "fieldApiName": "FinServ__AUM__c",
17      "dataType": "Currency",
18      "label": "Assets Under Management",
19      "value": "1250000",
20      "metadata": null
21    }
22  ]
23}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`accountData`	Client Snapshot Field[]	List of fields associated with the account.	Big, 67.0	67.0
`accountId`	String	ID of the account to get the summary for.	Big, 67.0	67.0
`accountType`	String	Type of account, such as HOUSEHOLD. For non-household type accounts, the API shows an error. Valid values are INDIVIDUAL, HOUSEHOLD, and BUSINESS.	Big, 67.0	67.0
`primaryMemberData`	Client Snapshot Field[]	List of fields associated with the primary member of the household account.	Big, 67.0	67.0
`primaryMemberId`	String	ID of the primary member of the household. Shows `null` if no primary member is configured for the household.	Big, 67.0	67.0