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.
{
"inputs": [
{
"contractGroupPlanId": "0rgZM0000004C9NYAU",
"groupCensusMembers": [
{
"attributes": {
"type": "GroupCensusMember"
},
"Id": "0rhZM0000004C9NYAU",
"GroupCensusId": "0rfZM0000008OIFYA2",
"AccountId": "001ZM000002jgdjYAA",
"AssociationWithPrimaryMbr": "Self",
"EventEffectiveDate": "2027-08-10"
}
],
"pricingResult": [
{
"attributes": {
"type": "ind_ins_grpben__MembersPlansRatingOutput"
},
"groupCensusMemberId": "0rhZM0000004C9NYAU",
"contractGroupPlanId": "0rgZM0000004C9NYAU",
"totalPremium": 300
}
]
}
]
}
This sample success response is for the Renew Group Census Member Policies action.
[
{
"actionName": "renewGroupCensusMemberPolicies",
"isSuccess": true,
"errors": null,
"outputValues": {
"insurancePolicyIds": [ "0YTZM0000009AbC4AU" ]
}
}
]
This sample response with errors for the Renew Group Census Member Policies action.
[
{
"actionName": "renewGroupCensusMemberPolicies",
"isSuccess": false,
"errors": [
{
"statusCode": "SOMETHING_UNEXPECTED_HAPPENED",
"message": "Something went wrong. Ask your Salesforce admin for help.",
"fields": []
}
],
"outputValues": { "insurancePolicyIds": null }
}
]