Insurance Member Plans (POST, PATCH)

Create and update insurance plans for a group census member.

Resource

{memberId} is a placeholder.

1/connect/insurance/census-management/group-census-members/{memberId}/plans

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-census-members/0r6RM0000000h1pYAA/plans

Available Version

65.0

HTTP Methods

POST, PATCH

Path Parameter for POST and PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
`memberId`	String	ID of the group census member for whom insurance plans must be created or updated.	Required	65.0

Request Body for POST

JSON Example

1{
2  "groupCensusMemberPlans": {
3    "values": [
4      {
5        "contractGroupPlanId": "0rgSG0000000e8jYAA"
6      },
7      {
8        "contractGroupPlanId": "0rgSG0000000eALYAY"
9      }
10    ]
11  }
12}

This is a sample example to add off-contract coverages.

1{
2  "groupCensusMemberPlans": {
3    "values": [
4      {
5        "contractGroupPlanId": "0rgSG0000000e8jYAA"
6      },
7      {
8        "productCode": "01tSG0000000abcDEF",
9        "rootProductCode": "0rgSG0000000e8jYAA"
10      }
11    ]
12  }
13}

This is a sample example to add off-contract coverages with the attribute-level changes.

1{
2  "groupCensusMemberPlans": {
3    "values": [
4      {
5        "contractGroupPlanId": "0rgSG0000000e8jYAA",
6        "attributes": {
7          "values": [
8            {
9              "attributeCode": "code",
10              "attributeValue": "25"   
11            }
12          ]
13        }
14      }
15    ]
16  }
17}

Properties

Name	Type	Description	Required or Optional	Available Version
`groupCensusMemberPlans`	Group Census Member Plan Input[]	List of plans to add to the member.	Required	65.0

Response Body for POST

Insurance Add Member Plans

Request Body for PATCH

JSON Example

1{
2  "addedPlans": {
3    "values": [
4      {
5        "contractGroupPlanId": "0rgSG0000000e8jYAA"
6      },
7      {
8        "contractGroupPlanId": "0rgSG0000000eALYAY"
9      }
10    ]
11  },
12  "upsertedPlans": {
13    "contractGroupPlanId": "0rgxx00000000OEAAY",
14    "attributes": {
15      "values": [
16        {
17          "attributeCode": "Deductible",
18          "attributeValue": "0"
19        }
20      ]
21    }
22  },
23  "deletedPlans": {
24    "values": [
25      "0rgSG0000000eALYAY",
26      "0rgSG0000000e8jYAA"
27    ]
28  }
29}

Properties

Name	Type	Description	Required or Optional	Available Version
`addedPlans`	Group Census Member Plan Input[]	List of plans to add to the member.	Optional	65.0
`deletedPlans`	String[]	List of group census member plan IDs to delete.	Optional	65.0
`upsertedPlans`	Group Census Member Plan Input[]	List of existing member plans to update or add if they don’t exist, including attribute-level changes to plans the member already has.	Optional	65.0

Response Body for PATCH

Insurance Update Member Plans