Group Census Members With Plans (POST, PATCH)

Add or update a family of group census members and their insurance plans in a group census. Use POST to add members and plans, and PATCH to update an existing family and the plans associated with those members.

Resource

{censusId} is a placeholder.

1/connect/insurance/group-censuses/{censusId}/members-with-plans

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/members-with-plans

Available Version

68.0

HTTP Methods

POST, PATCH

Path Parameter for POST and PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
`censusId`	String	ID of the group census that the members and plans belong to.	Required	68.0

Request Body for POST

JSON Example

1{
2  "duplicateDetectionFields": [
3    "FirstName", "LastName", "Email"
4  ],
5  "flowName": "Process Group Census Member Data",
6  "shouldExecuteConfigurationRule": false,
7  "members": [
8    {
9      "firstName": "Alex",
10      "lastname": "Taylor",
11      "email": "alex.taylor@example.com",
12      "memberType": "Primary",
13      "associationWithPrimaryMbr": "Self",
14      "relationshipToPrimaryMember": "Self",
15      "sourceSystemIdentifier": "WD-EMP-67890",
16      "groupClassName": "Full-Time Salaried",
17      "addedPlans": [
18        {
19          "contractGroupPlanId": "0gpxx0000000001AAA",
20          "name": "Gold Tier Medical Plan",
21          "attributes": [
22            {
23              "attributeCode": "COVERAGE_TIER",
24              "attributeValue": "Family"
25            }
26          ]
27        }
28      ]
29    }
30  ]
31}

Properties

Name	Type	Description	Required or Optional	Available Version
`duplicateDetectionFields`	String[]	List of field API names that are used with the default fields to generate a unique key for identifying duplicate members. The default fields are `FirstName`, `LastName`, `AssociationWithPrimaryMbr`, `Email`, and `GroupCensusId`.	Optional	68.0
`flowName`	String	Name of the flow to use for processing group census member data. The default value is `Process Group Census Member Data`.	Optional	68.0
`members`	Member With Plans Input[]	List of group census members with their plan details to add or update.	Required	68.0
`shouldExecuteConfigurationRule`	Boolean	Indicates whether the flow runs the eligibility and configurator engine when validating the submitted plans ( `true`) or saves the submitted plans as-is ( `false`). The default value is `false`.	Optional	68.0

Response Body for POST

Members With Plans Response

Request Body for PATCH

JSON Example

1{
2  "duplicateDetectionFields": [
3    "FirstName", "LastName", "Email"
4  ],
5  "flowName": "Process Group Census Member Data",
6  "shouldExecuteConfigurationRule": false,
7  "members": [
8    {
9      "firstName": "Alex",
10      "lastname": "Taylor",
11      "email": "alex.taylor@example.com",
12      "memberType": "Primary",
13      "associationWithPrimaryMbr": "Self",
14      "relationshipToPrimaryMember": "Self",
15      "sourceSystemIdentifier": "WD-EMP-67890",
16      "groupClassName": "Full-Time Salaried",
17      "addedPlans": [
18        {
19          "contractGroupPlanId": "0gpxx0000000001AAA",
20          "name": "Gold Tier Medical Plan",
21          "attributes": [
22            {
23              "attributeCode": "COVERAGE_TIER",
24              "attributeValue": "Family"
25            }
26          ]
27        }
28      ]
29    }
30  ]
31}

Properties

Name	Type	Description	Required or Optional	Available Version
`duplicateDetectionFields`	String[]	List of field API names that are used with the default fields to generate a unique key for identifying duplicate members. The default fields are `FirstName`, `LastName`, `AssociationWithPrimaryMbr`, `Email`, and `GroupCensusId`.	Optional	68.0
`flowName`	String	Name of the flow to use for processing group census member data. The default value is `Process Group Census Member Data`.	Optional	68.0
`members`	Member With Plans Input[]	List of group census members with their plan details to add or update.	Required	68.0
`shouldExecuteConfigurationRule`	Boolean	Indicates whether the flow runs the eligibility and configurator engine when validating the submitted plans ( `true`) or saves the submitted plans as-is ( `false`). The default value is `false`.	Optional	68.0

Response Body for PATCH

Members With Plans Response