Delete Note

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

Required permission: Permission depends on entity type:

• events → claim.notes:update
• policies → policy.notes:update
• insureds → insured.notes:update

DELETE /api/external/companies/{companyId}/{entityType}/{entityId}/notes/{noteId}

Delete Note

cURL

curl --request DELETE \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/notes/{noteId} \
  --header 'Authorization: <api-key>'

200

Example

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

entityType · enum<string> · required

The type of entity (events, policies, or insureds) The type of entity the note is attached to

Available options: events, policies, insureds

entityId · string<uuid> · required

The ID of the entity

noteId · string<uuid> · required

Note identifier

Response

200

application/json

Note deleted successfully

id · string<uuid>

The ID of the deleted note

deleted · boolean

Confirmation that the note was deleted