Insurance Group Census Members (POST, PATCH, DELETE)

Add (POST) and update (PATCH) group census members. Delete all census members for the specified group census ID.

Resource

{groupCensusId} is a placeholder.

1/connect/insurance/census-management/group-censuses/{groupCensusId}/group-census-members

Resource Example

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

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-censuses/0rlxx000000001aEAA/group-census-members

Available Version

65.0

HTTP Methods

POST, PATCH, DELETE

Path Parameter for POST, PATCH, and DELETE

Parameter Name	Type	Description	Required or Optional	Available Version
`groupCensusId`	String	ID of the group census.	Required	65.0

Request Body for POST

JSON Example

1{
2  "members": {
3    "values": [
4      {
5                    "name": "member1",
6                    "firstName": "fm",
7                    "lastname": "lm",
8                    "email": "cci@test.com",
9                    "sourceSystemIdentifier": "1.primary",
10                    "primaryMemberSource": null,
11                    "relationshipToPrimaryMember": "Self",
12                    "associationWithPrimaryMbr": "Self"
13                },
14                {
15                    "name": "member2",
16                    "firstName": "fm2",
17                    "lastname": "lm2",
18                    "email": "cci@test.com",
19                    "sourceSystemIdentifier": "2.primary",
20                    "primaryMemberSource": null,
21                    "relationshipToPrimaryMember": "Self",
22                    "associationWithPrimaryMbr": "Self"
23                },
24                {
25                    "name": "dep1",
26                    "firstName": "depfm",
27                    "lastname": "depfm",
28                    "email": "cci@test.com",
29                    "associationWithPrimaryMbr": "Child",
30                    "relationshipToPrimaryMember": "Child",
31                    "sourceSystemIdentifier": "1.Child",
32                    "primaryMemberSource": "1.primary"
33                },
34                {
35                    "name": "dep2",
36                    "firstName": "depfm2",
37                    "lastname": "depfm2",
38                    "email": "cci@test.com",
39                    "associationWithPrimaryMbr": "Child",
40                    "relationshipToPrimaryMember": "Child",
41                    "sourceSystemIdentifier": "2.Child",
42                    "primaryMemberSource": "2.primary"
43                }
44    ]
45  },
46  "duplicateDetectionFields": {
47    "values": [
48      "firstName"
49    ]
50  }
51}

Properties

Name	Type	Description	Required or Optional	Available Version
`duplicateDetectionFields`	String[]	List of field API names that are used to generate a unique key for identifying duplicate members along with default values. The default fields for duplicate detection are `FirstName`, `LastName`, `AssociationWithPrimaryMbr`, and `GroupCensusId`.	Optional	65.0
`flowName`	String	Name of the flow to use for processing group member data. Default value is Process Group Census Member Data.	Optional	65.0
`members`	Group Census Member Input[]	List of group census members to add or update.	Required	65.0

Response Body for POST

Insurance Group Census Member Management

Request Body for PATCH

JSON Example

1{
2  "members": {
3    "values": [
4      {
5                    "name": "member1",
6                    "firstName": "fm",
7                    "lastname": "lm",
8                    "email": "cci@test.com",
9                    "sourceSystemIdentifier": "1.primary",
10                    "primaryMemberSource": null,
11                    "relationshipToPrimaryMember": "Self",
12                    "associationWithPrimaryMbr": "Self"
13                },
14                {
15                    "name": "member2",
16                    "firstName": "fm2",
17                    "lastname": "lm2",
18                    "email": "cci@test.com",
19                    "sourceSystemIdentifier": "2.primary",
20                    "primaryMemberSource": null,
21                    "relationshipToPrimaryMember": "Self",
22                    "associationWithPrimaryMbr": "Self"
23                },
24                {
25                    "name": "dep1",
26                    "firstName": "depfm",
27                    "lastname": "depfm",
28                    "email": "cci@test.com",
29                    "associationWithPrimaryMbr": "Child",
30                    "relationshipToPrimaryMember": "Child",
31                    "sourceSystemIdentifier": "1.Child",
32                    "primaryMemberSource": "1.primary"
33                },
34                {
35                    "name": "dep2",
36                    "firstName": "depfm2",
37                    "lastname": "depfm2",
38                    "email": "cci@test.com",
39                    "associationWithPrimaryMbr": "Child",
40                    "relationshipToPrimaryMember": "Child",
41                    "sourceSystemIdentifier": "2.Child",
42                    "primaryMemberSource": "2.primary"
43                }
44    ]
45  },
46  "duplicateDetectionFields": {
47    "values": [
48      "firstName"
49    ]
50  }
51}

Properties

Name	Type	Description	Required or Optional	Available Version
`duplicateDetectionFields`	String[]	List of field API names that are used to generate a unique key for identifying duplicate members along with default values. The default fields for duplicate detection are `FirstName`, `LastName`, `AssociationWithPrimaryMbr`, and `GroupCensusId`.	Optional	65.0
`flowName`	String	Name of the flow to use for processing group member data. Default value is Process Group Census Member Data.	Optional	65.0
`members`	Group Census Member Input[]	List of group census members to add or update.	Required	65.0

Response Body for PATCH

Insurance Group Census Member Management

Response Body for DELETE

Insurance Group Census Member Management