Legacy Renewal API (Deprecated)
Warning
The following API elements are deprecated. See the Renewals API topic for details on current renewal functionality.
Endpoint Index
Action | Endpoint |
---|---|
Issue a renewal | POST /policy/{policyLocator}/issueRenewal |
Preview a renewal's pricing | POST /policy/{policyLocator}/previewRenewalPrice |
Details
The following endpoint will create and issue a renewal in one shot. This endpoint is deprecated and may be removed in a future release.
Issue a renewal¶
POST /policy/{policyLocator}/issueRenewal
Name | Position | Type | Required |
---|---|---|---|
policyLocator | path | string | required |
request | body | RenewalIssueRequest | required |
RenewalIssueRequest¶
requiredrenewalEndTimestamp timestampoptionalpolicyUpdateRequest RenewalPolicyUpdateRequest
RenewalPolicyUpdateRequest¶
requiredaddFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]addExposures [ExposureCreateRequest]updateExposures [RenewalExposureUpdateRequest]endExposures [string]optionalfieldValues map<string,[string]>newPaymentScheduleName string
RenewalExposureUpdateRequest¶
requiredfieldValues map<string,[string]>addFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]addPerils [PerilCreateRequest]updatePerils [PerilUpdateRequest]endPerils [string]exposureLocator string
Preview a renewal's pricing¶
POST /policy/{policyLocator}/previewRenewalPrice
Name | Position | Type | Required |
---|---|---|---|
policyLocator | path | string | required |
request | body | RenewalIssueRequest | required |
This endpoint will price a prospective renewal without actually creating or issuing it. Note: locators for newly added exposures and perils are transient and will be different from those that would be created if the endorsement were actually created.