Create Configuration Rating Output

Creates a new rating output field (entity name: rating_engine_display) and an associated smart tag with the naming convention AII{key}PrimaryInsured.

The field definition is stored in company_fields, an association is created in company_entity_fields, and a smart tag is created in smart_tags.

Allowed field class names: InputField

The field key cannot be companyId (reserved) and must be alphanumeric ([A-Za-z0-9]+) since the smart tag name is derived from it.

Required permission: company:update

POST /api/external/companies/{companyId}/configuration/rating/outputs

cURL

minimalInput

curl --request POST \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/outputs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldDefinition": {
    "className": "InputField",
    "key": "AnnualRate",
    "path": "entityData.AnnualRate"
  }
}
'

201

success

{
  "id": "550e8400-e29b-41d4-a716-446655440100"
}

Authorizations

Authorization · string · header · required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId · string<uuid> · required

Company identifier

Body

application/json

Request body for creating a configuration rating output field

fieldDefinition · object · required

Field definition specifying the rating output field's type, key, and configuration

Show child attributes

Response

201

application/json

Configuration rating output field created successfully

id · string<uuid>

The ID of the created rating output field