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.

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

Resource Example

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

https://{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

{
  "members": {
    "values": [
      {
                    "name": "member1",
                    "firstName": "fm",
                    "lastname": "lm",
                    "email": "cci@test.com",
                    "sourceSystemIdentifier": "1.primary",
                    "primaryMemberSource": null,
                    "relationshipToPrimaryMember": "Self",
                    "associationWithPrimaryMbr": "Self"
                },
                {
                    "name": "member2",
                    "firstName": "fm2",
                    "lastname": "lm2",
                    "email": "cci@test.com",
                    "sourceSystemIdentifier": "2.primary",
                    "primaryMemberSource": null,
                    "relationshipToPrimaryMember": "Self",
                    "associationWithPrimaryMbr": "Self"
                },
                {
                    "name": "dep1",
                    "firstName": "depfm",
                    "lastname": "depfm",
                    "email": "cci@test.com",
                    "associationWithPrimaryMbr": "Child",
                    "relationshipToPrimaryMember": "Child",
                    "sourceSystemIdentifier": "1.Child",
                    "primaryMemberSource": "1.primary"
                },
                {
                    "name": "dep2",
                    "firstName": "depfm2",
                    "lastname": "depfm2",
                    "email": "cci@test.com",
                    "associationWithPrimaryMbr": "Child",
                    "relationshipToPrimaryMember": "Child",
                    "sourceSystemIdentifier": "2.Child",
                    "primaryMemberSource": "2.primary"
                }
    ]
  },
  "duplicateDetectionFields": {
    "values": [
      "firstName"
    ]
  }
}

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

{
  "members": {
    "values": [
      {
                    "name": "member1",
                    "firstName": "fm",
                    "lastname": "lm",
                    "email": "cci@test.com",
                    "sourceSystemIdentifier": "1.primary",
                    "primaryMemberSource": null,
                    "relationshipToPrimaryMember": "Self",
                    "associationWithPrimaryMbr": "Self"
                },
                {
                    "name": "member2",
                    "firstName": "fm2",
                    "lastname": "lm2",
                    "email": "cci@test.com",
                    "sourceSystemIdentifier": "2.primary",
                    "primaryMemberSource": null,
                    "relationshipToPrimaryMember": "Self",
                    "associationWithPrimaryMbr": "Self"
                },
                {
                    "name": "dep1",
                    "firstName": "depfm",
                    "lastname": "depfm",
                    "email": "cci@test.com",
                    "associationWithPrimaryMbr": "Child",
                    "relationshipToPrimaryMember": "Child",
                    "sourceSystemIdentifier": "1.Child",
                    "primaryMemberSource": "1.primary"
                },
                {
                    "name": "dep2",
                    "firstName": "depfm2",
                    "lastname": "depfm2",
                    "email": "cci@test.com",
                    "associationWithPrimaryMbr": "Child",
                    "relationshipToPrimaryMember": "Child",
                    "sourceSystemIdentifier": "2.Child",
                    "primaryMemberSource": "2.primary"
                }
    ]
  },
  "duplicateDetectionFields": {
    "values": [
      "firstName"
    ]
  }
}

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