Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Group Benefits Business APIs
Resources
Create Quote From Insurance Contract (POST)
Deep Clone Group Census (POST)
Endorse Contract (POST)
Map Group Census Fields (POST)
Member Overrides (POST, DELETE)
Group Renewal (POST)
Group Census Price Comparisons (POST)
Group Census Members With Plans (POST, PATCH)
Generate Insurance Contract Transactions (POST)
Generate Group Census From Insurance Contract (POST)
Update Group Census (PATCH)
Generate or Update Group Census Members (POST)
Group Enrollment (POST)
Individual Enrollment (POST)
Insurance Person Accounts and Users (POST)
Insurance Contacts and Users (POST)
Insurance Member Rating (POST)
Insurance Bulk Census Management (POST)
Insurance Group Census Members (POST, PATCH, DELETE)
Insurance Group Census Members Delete (POST)
Insurance Group Rating (POST)
Insurance Census Summary Sync (POST)
Insurance Member Plans (POST, PATCH)
Insurance Member Plans Delete (POST)
Insurance Member Eligible Plans (GET)
Insurance Plans Eligibility Check (POST, PATCH)
Issue Contract From Quote Asynchronous (POST)
Issue Contract From Quote (POST)
Member Policies Adjustment (POST)
Member Plans Adjustment (POST)
Renew Contract (POST)
Requests
Responses
Insurance Group Benefits Apex Reference
Insurance Group Benefits Standard Invocable Actions
Insurance Group Benefits Metadata API Types
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Group Renewal (POST)

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
1/connect/insurance/group-censuses/censusId/policies/actions/renew
Resource example
1https://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
1{
2  "flowName": "RenewMemberPolicies",
3  "shouldReprice": true
4}
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
Response body for POST
Insurance Group Renewal Response