curl --request POST \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ratingEngineRevisionId": "e06153b8-53c8-4305-bc23-0b67450ec450",
"revisionStrategy": "UpdateExistingRevision",
"ruleName": "Attach Certificate of Insurance",
"rank": 1,
"step": "policies",
"shouldAdd": {
"leftKey": "form.number",
"operator": "=",
"rightValue": "FM-0001"
}
}
'{
"id": "bc6a626e-7a96-49fd-b477-2b18cf189a0d"
}Create Rating Revision Form Logic
Creates a new form-logic rule in the rating engine revision’s config JSON
(rating_engine_revisions.config.policyFormLogicConfigs). Rules determine
which forms are attached to policies or quotes based on a shouldAdd
expression evaluated during rating.
The ratingEngineRevisionId must reference an existing, non-deleted
revision owned by this company.
Required permission: company:update
curl --request POST \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ratingEngineRevisionId": "e06153b8-53c8-4305-bc23-0b67450ec450",
"revisionStrategy": "UpdateExistingRevision",
"ruleName": "Attach Certificate of Insurance",
"rank": 1,
"step": "policies",
"shouldAdd": {
"leftKey": "form.number",
"operator": "=",
"rightValue": "FM-0001"
}
}
'{
"id": "bc6a626e-7a96-49fd-b477-2b18cf189a0d"
}Authorizations
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Body
Request body for creating a form-logic rule in a rating engine revision's config JSON
The rating engine revision to add this rule to. Must reference an existing, non-deleted revision belonging to this company (otherwise the request returns 404).
How to handle the rating engine revision. UpdateExistingRevision modifies the specified revision in place. CreateNewRevision is not yet implemented and will return a 501 error.
UpdateExistingRevision, CreateNewRevision Human-readable name for the rule (e.g. "Attach Certificate of Insurance").
1Sort order for this rule relative to others on the same revision. Controls the position of attached forms in the output list (lower numbers appear first). Duplicates are permitted.
A conditional expression that evaluates to true or false during rating (of either a quote or a policy). Determines whether a form should be attached. Three variants are supported.
- Branch Expression
- Leaf Expression
- Inverted Leaf Expression
Show child attributes
Show child attributes
Tag controlling which form-selection contexts this rule's output appears in — "policies" (output appears during policy form selection), "quotes" (output appears during quote form selection), or an array of these values. If omitted, the rule's output only appears during policy form selection; specify "quotes" (or an array that includes it) to also participate in quote form selection.
policies, quotes Response
Form-logic rule created successfully
The server-generated ID of the created rule
Was this page helpful?