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

{
  "accountId": "001RO000002Kn4BYAS",
  "accountType": "HOUSEHOLD",
  "primaryMemberId": "001RO000002Kn5CZAT",
  "primaryMemberData": [
    {
      "fieldApiName": "Name",
      "dataType": "String",
      "label": "Name",
      "value": "Jane Smith",
      "metadata": null
    }
  ],
  "accountData": [
    {
      "fieldApiName": "FinServ__AUM__c",
      "dataType": "Currency",
      "label": "Assets Under Management",
      "value": "1250000",
      "metadata": null
    }
  ]
}

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