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.
/connect/insurance/group-censuses/{censusId}/members-with-plans
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{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
{
"duplicateDetectionFields": [
"FirstName", "LastName", "Email"
],
"flowName": "Process Group Census Member Data",
"shouldExecuteConfigurationRule": false,
"members": [
{
"firstName": "Alex",
"lastname": "Taylor",
"email": "alex.taylor@example.com",
"memberType": "Primary",
"associationWithPrimaryMbr": "Self",
"relationshipToPrimaryMember": "Self",
"sourceSystemIdentifier": "WD-EMP-67890",
"groupClassName": "Full-Time Salaried",
"addedPlans": [
{
"contractGroupPlanId": "0gpxx0000000001AAA",
"name": "Gold Tier Medical Plan",
"attributes": [
{
"attributeCode": "COVERAGE_TIER",
"attributeValue": "Family"
}
]
}
]
}
]
}
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 |
Request Body for PATCH
JSON Example
{
"duplicateDetectionFields": [
"FirstName", "LastName", "Email"
],
"flowName": "Process Group Census Member Data",
"shouldExecuteConfigurationRule": false,
"members": [
{
"firstName": "Alex",
"lastname": "Taylor",
"email": "alex.taylor@example.com",
"memberType": "Primary",
"associationWithPrimaryMbr": "Self",
"relationshipToPrimaryMember": "Self",
"sourceSystemIdentifier": "WD-EMP-67890",
"groupClassName": "Full-Time Salaried",
"addedPlans": [
{
"contractGroupPlanId": "0gpxx0000000001AAA",
"name": "Gold Tier Medical Plan",
"attributes": [
{
"attributeCode": "COVERAGE_TIER",
"attributeValue": "Family"
}
]
}
]
}
]
}
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 |