Delete Event

Soft deletes an event by setting deletedAt and deletedBy timestamps. The event will no longer be returned in list or get operations.

Financial Transaction Protection: By default, events with paid or processing financial transactions cannot be deleted. This protects financial data integrity. If you need to delete such an event, set force: true in the request body.

⚠️ WARNING: Using force: true will orphan the associated financial records. Only use this option if you understand the implications.

Required fields in request body:

• type - Event type (required for permission resolution)

Optional fields:

• force - Set to true to delete events with paid/processing transactions (use with caution)

Required permission: company.claim:delete or company.incident:delete (depending on type)

DELETE /api/external/companies/{companyId}/events/{eventId}

cURL

deleteClaim

curl --request DELETE \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "claim"
}
'

200

success

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "deleted": true
}

Authorizations

Authorization · string · header · required

Use format: ApiKey <your-api-key>

Path Parameters

companyId · string<uuid> · required

Company identifier

eventId · string<uuid> · required

Event identifier

Body

application/json

type · enum<string> · required

Type of event (claim or incident)

Available options: claim, incident

force · boolean

If true, allows deletion even when the event has paid or processing financial transactions. WARNING: Force deleting will orphan these financial records. Use with caution.

Response

200

application/json

Event deleted successfully

id · string<uuid>

The ID of the deleted event

deleted · boolean

Confirmation that the event was deleted