Delete Configuration Field

Deletes a configuration field by ID. The field must be an entity field (events, insureds, or policies) — rating fields cannot be deleted through this endpoint.

The field definition and its entity association are permanently deleted.

Required permission: company:update

DELETE /api/external/companies/{companyId}/configuration/fields/{fieldId}

Delete Configuration Field

cURL

curl --request DELETE \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/fields/{fieldId} \
  --header 'Authorization: <api-key>'

200

success

{
  "id": "550e8400-e29b-41d4-a716-446655440100",
  "deleted": 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

fieldId · string<uuid> · required

Configuration field identifier

Response

200

application/json

Configuration field deleted successfully

id · string<uuid>

The ID of the deleted configuration field

deleted · boolean

Confirmation that the field was deleted