Insurance Census Filter Input

Input representation of the filter criteria that select which policy records to include when generating a group census from a contract.

JSON Example 

1{
2  "contractGroupPlanIds": [
3    "0gpxx0000000001AAA"
4  ],
5  "objectName": "Contact",
6  "recordIds": [
7    "003xx000004WhKhAAK"
8  ]
9}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
contractGroupPlanIdsString[]IDs of the root contract group plans to include when generating the group census.Optional68.0
objectNameStringAPI name of the object that the specified member record IDs belong to, such as Contact or PersonAccount.Optional68.0
recordIdsString[]IDs of the specific records to include when generating the group census. Valid values are contact IDs and person account IDs. The IDs must belong to the object specified in objectName.Optional68.0