renewInsurancePolicy(insurancePolicyProcessInput, policyId)

Renew policy for the specified insurance policy ID.

63.0

No

public static ConnectApi.InsurancePolicyProcessOutputRepresentation renewInsurancePolicy(ConnectApi.InsurancePolicyRenewInputRepresentation insurancePolicyProcessInput, String policyId)

insurancePolicyProcessInput

policyId

  • Type: String
  • ID of the insurance policy that’s to be renewed.

Type: ConnectApi.InsurancePolicyProcessOutputRepresentation

The Insurance Policy Renewal API takes a JSON input that contains the insurance policy ID that must be renewed along with the fieldValueMap details. The API submits the request to a queue, creates a policy, along with child records by using the context definition selected in setup. The service also overrides the fieldValueMap in the new policy for the policy ID passed in the request. Users receive success and failure notifications on request completion.

Keep these considerations in mind when you use this method.

  • The RenewedFromPolicyId value of the new policy is set to the current policy ID and IsRenewedPolicy field of the new policy is set to true.
  • The fieldValueMap expects the keys to be API name and is case-sensitive.

The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.renewInsurancePolicy() method to reinstate a previously canceled insurance policy.

Class Definition

This Apex example shows how to renew an insurance policy.

Usage Example

Use the RenewTestConnectAPI class to execute the renew action and process the result.