Renew Group Census Member Policies Action

Renew group census member policies for contract renewal. This action creates renewed insurance policies, and links the newly created policies to the previous policies.

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/renewGroupCensusMemberPolicies

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`contractGroupPlanId`	string	Required. ID of the contract group plan to process for member policy renewal.
`groupCensusMembers`	sobject	Required. Group census member records to process for renewal. The members must have an active insurance policy under the contract being renewed.
`pricingResult`	Apex-defined	A collection of Apex `ind_ins_grpben__MembersPlansRatingOutput` records that contain pricing results for the member policies to be renewed.

Outputs

Output	Type	Description
`insurancePolicyIds`	string	IDs of the renewed policies for the group census members.

Example

POST

This sample request is for the Renew Group Census Member Policies action.

1{
2  "inputs": [
3    {
4      "contractGroupPlanId": "0rgZM0000004C9NYAU",
5      "groupCensusMembers": [
6        {
7          "attributes": {
8            "type": "GroupCensusMember"
9          },
10          "Id": "0rhZM0000004C9NYAU",
11          "GroupCensusId": "0rfZM0000008OIFYA2",
12          "AccountId": "001ZM000002jgdjYAA",
13          "AssociationWithPrimaryMbr": "Self",
14          "EventEffectiveDate": "2027-08-10"
15        }
16      ],
17      "pricingResult": [
18        {
19          "attributes": {
20            "type": "ind_ins_grpben__MembersPlansRatingOutput"
21          },
22          "groupCensusMemberId": "0rhZM0000004C9NYAU",
23          "contractGroupPlanId": "0rgZM0000004C9NYAU",
24          "totalPremium": 300
25        }
26      ]
27    }
28  ]
29}

This sample success response is for the Renew Group Census Member Policies action.

1[
2    {
3      "actionName": "renewGroupCensusMemberPolicies",
4      "isSuccess": true,
5      "errors": null,
6      "outputValues": {
7        "insurancePolicyIds": [ "0YTZM0000009AbC4AU" ]
8      }
9    }
10  ]

This sample response with errors for the Renew Group Census Member Policies action.

1[
2    {
3      "actionName": "renewGroupCensusMemberPolicies",
4      "isSuccess": false,
5      "errors": [
6        {
7          "statusCode": "SOMETHING_UNEXPECTED_HAPPENED",
8          "message": "Something went wrong. Ask your Salesforce admin for help.",
9          "fields": []
10        }
11      ],
12      "outputValues": { "insurancePolicyIds": null }
13    }
14  ]