renewInsurancePolicy(insurancePolicyProcessInput, policyId)

API Version

63.0

Requires Chatter

No

Signature

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

1ConnectApi.InsuranceBrokerageFamily, renewInsurancePolicy, [ConnectApi.InsurancePolicyRenewInputRepresentation, String], ConnectApi.InsurancePolicyProcessOutputRepresentation

Parameters

insurancePolicyProcessInput

Type: ConnectApi.InsurancePolicyRenewInputRepresentation

Input representation details of the request to renew an insurance policy.

policyId

Type: String

ID of the insurance policy that's to be renewed.

Return Value

Type: ConnectApi.InsurancePolicyProcessOutputRepresentation

Usage

The Insurance Policy Renewal API takes a JSON input that contains the insurance policy ID that must be renewed along with the fieldValueMap and sameCarrier 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.
• If the policy is renewed with the same carrier, the PriorPolicyId field of the new policy is updated with the current policy ID.
• The fieldValueMap expects the keys to be API name and is case-sensitive.