Create and update insurance plans for a group census member.
Resource
{memberId} is a placeholder.
/connect/insurance/census-management/group-census-members/{memberId}/plans
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-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
{
"groupCensusMemberPlans": {
"values": [
{
"contractGroupPlanId": "0rgSG0000000e8jYAA"
},
{
"contractGroupPlanId": "0rgSG0000000eALYAY"
}
]
}
}
This is a sample example to add off-contract coverages.
{
"groupCensusMemberPlans": {
"values": [
{
"contractGroupPlanId": "0rgSG0000000e8jYAA"
},
{
"productCode": "01tSG0000000abcDEF",
"rootProductCode": "0rgSG0000000e8jYAA"
}
]
}
}
This is a sample example to add off-contract coverages with the attribute-level changes.
{
"groupCensusMemberPlans": {
"values": [
{
"contractGroupPlanId": "0rgSG0000000e8jYAA",
"attributes": {
"values": [
{
"attributeCode": "code",
"attributeValue": "25"
}
]
}
}
]
}
}
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 |
Request Body for PATCH
JSON Example
{
"addedPlans": {
"values": [
{
"contractGroupPlanId": "0rgSG0000000e8jYAA"
},
{
"contractGroupPlanId": "0rgSG0000000eALYAY"
}
]
},
"upsertedPlans": {
"contractGroupPlanId": "0rgxx00000000OEAAY",
"attributes": {
"values": [
{
"attributeCode": "Deductible",
"attributeValue": "0"
}
]
}
},
"deletedPlans": {
"values": [
"0rgSG0000000eALYAY",
"0rgSG0000000e8jYAA"
]
}
}
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 |