Skip to main content
POST
Retire Quote Rating

Authorizations

Authorization
string
header
required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId
string<uuid>
required

Company identifier

quoteId
string<uuid>
required

Quote identifier

Body

application/json
ratingWorkflowName
string
required

The configured name of the workflow whose current rating to retire

Minimum string length: 1

Response

The workflow's current rating is retired, or was left as it is. The quote itself is unchanged either way.

quoteId
string<uuid>
required

The quote

ratingWorkflowName
string
required

The workflow named in the request

outcome
enum<string>
required

retired: the rating was made under an earlier version of the workflow, or under a workflow no longer configured, or recorded nothing to judge it by, and nothing else makes it out of date; it is no longer current. noCurrentRating: the quote has no current rating for the workflow. workflowUnchanged: the rating was made under the workflow as it is configured now, so it stays current. outOfDate: the workflow changed since the rating, but the rating is out of date for changed too, so it stays current and keeps that warning.

Available options:
retired,
noCurrentRating,
workflowUnchanged,
outOfDate
ratingRunId
string<uuid>

The rating retired, or the one that stays current. Absent with noCurrentRating.

changed
string[]

outOfDate only: what besides the workflow changed since the rating. Each entry is the path of an input it read (such as quote.excessLiabilityPremium), window (the term), policyVersion, or raterVersion.