Renew insurance policies of group census members for a contract renewal. This API
creates insurance policies under the renewed contract for each primary census member in the
specified group census, links the new policies to their previous policies, and records renewal
transactions. The API runs asynchronously and returns a request ID that you can use to track the
job status.
Resource
{censusId} is a placeholder.
/connect/insurance/group-censuses/{censusId}/policies/actions/renew
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/policies/actions/renew
Available Version
68.0
HTTP Methods
POST
Path Parameter for POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| censusId | String | ID of the group census whose primary members' policies must be renewed. | Required | 68.0 |
Request Body for POST
JSON Example
{
"flowName": "RenewMemberPolicies",
"shouldReprice": true
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| flowName | String | API name of the flow to use for member-policy renewal. If not specified, the default RenewMemberPolicies flow is used. | Optional | 68.0 |
| shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 |