Run Proposal Rating with Options

post

https://{environment}.origamirisk.com/OrigamiApi/api/Quotes/Proposals/{proposalId}/Rating/RunOptions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Runs the rating engine synchronously for a proposal with configurable options that override default rating behavior. This is the preferred endpoint for synchronous rating, providing full control over validation, worksheets, logging, and other rating engine settings. Due to the complexity of rating, this may result in calls taking longer than the allotted timeout period. Pairing this call with polling for status (GET .../Rating/Status) is recommended.

Examples

Scenario 1: Rate with custom options:

POST /api/Quotes/Proposals/12345/Rating/RunOptions
Content-Type: application/json

{
  "PreRatingValidations": false,
  "BuildRatingWorksheet": true,
  "VerboseLogging": true
}

200 OK
{
  "ProposalID": 12345,
  "RatingCalculationDate": "2026-05-10T14:30:00Z",
  "DeepModifiedDateUTC": "2026-05-10T14:25:00Z",
  "RatingStatus": "C",
  "RatingErrorMessage": null,
  "Premium": 5000.00,
  "TotalCost": 5250.00
}

Scenario 2: Attempt to use the unsupported SkipFinalSaveResults option:

POST /api/Quotes/Proposals/12345/Rating/RunOptions
Content-Type: application/json

{
  "SkipFinalSaveResults": true
}

500 Internal Server Error
"SkipFinalSaveResults option is not supported from the API."

Path Params

proposalId

integer

required

The ID of the Proposal to rate.

Body Params

RAW_BODY

json

required

Defaults to { "LoadExposures": true, "TopDownRating": true, "PreRatingValidations": true, "PostRatingValidations": true, "BuildRatingWorksheet": true, "VerboseLogging": true, "SkipFinalSaveResults": true, "RefreshSystemSelectedEndorsementForms": true }

Options to allow you to override configured rating behavior. All fields are optional (nullable booleans). Pass null or an empty object {} to use all defaults.

Field	Type	Default	Description
`LoadExposures`	`bool?`	`null`	Whether to load exposure data before rating.
`TopDownRating`	`bool?`	`null`	Whether to use top-down rating order.
`PreRatingValidations`	`bool?`	`null`	Whether to run pre-rating validations.
`PostRatingValidations`	`bool?`	`null`	Whether to run post-rating validations.
`BuildRatingWorksheet`	`bool?`	`null`	Whether to generate a detailed rating worksheet.
`VerboseLogging`	`bool?`	`null`	Whether to enable verbose logging during rating.
`SkipFinalSaveResults`	`bool?`	`null`	Not supported from the API. Setting this to `true` throws an error.
`RefreshSystemSelectedEndorsementForms`	`bool?`	`null`	Whether to refresh system-selected endorsement forms.
`AllowAsyncPostRatingOperations`	`bool?`	`null`	Whether to allow post-rating operations to run asynchronously.
`QuickRate`	`bool?`	`null`	Whether to perform a quick rate (simplified calculation).
`UseClassicRater`	`bool?`	`null`	Whether to use the classic (legacy) rating engine.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json