Skip to main content
PUT
/
api
/
external
/
companies
/
{companyId}
/
configuration
/
rating
/
fields
/
rank
Reorder Configuration Rating Fields
curl --request PUT \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields/rank \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityType": "policies",
  "fieldIds": [
    "550e8400-e29b-41d4-a716-446655440003",
    "550e8400-e29b-41d4-a716-446655440001",
    "550e8400-e29b-41d4-a716-446655440002"
  ]
}
'
{
  "updated": true
}

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 to reorder the rating input fields for a single (companyId, entityType) tuple.

The array index of each field id becomes its rank in application_fields. The provided fieldIds must exactly match the set of rating fields currently defined for this entityType — partial reorders and unknown ids are rejected.

​
entityType
string
required

The rating entity type whose fields are being reordered (e.g., policies, dealership, company).

Minimum string length: 1
Example:

"policies"

​
fieldIds
string<uuid>[]
required

Ordered list of rating field ids. The array index becomes the field's rank (lower renders first). Must contain no duplicates and must include every rating field currently defined for this (companyId, entityType) tuple — partial reorders are rejected.

Minimum array length: 1
Example:
[
  "550e8400-e29b-41d4-a716-446655440003",
  "550e8400-e29b-41d4-a716-446655440001",
  "550e8400-e29b-41d4-a716-446655440002"
]

Response

Rating field ranks updated successfully

Response returned after rating field ranks are updated.

​
updated
boolean
required

Always true when the request succeeded.

Example:

true