Create Note

Creates a new note attached to an event, policy, or insured.

Required permission: Permission depends on entity type:

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

Privileged notes: If isPrivileged is true, the API key must also have privileged_notes:read permission.

POST /api/external/companies/{companyId}/{entityType}/{entityId}/notes

cURL

basicNote

curl --request POST \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/notes \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Adjuster contacted claimant and scheduled inspection for Monday."
}
'

201

success

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

Authorizations

Authorization · string · header · required

Use format: ApiKey <your-api-key>

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

Body

application/json

text · string · required

The note content

isPrivileged · boolean · default: false

If true, the note is only visible to users with privileged_notes:read permission

createdAt · string<date-time>

Optional creation timestamp (ISO 8601). Defaults to current time if not provided.

authorId · string

ID of an existing user to set as the note author. Mutually exclusive with authorName.

authorName · string

Free-text author name for external authors not in the system. Mutually exclusive with authorId.

Response

201

application/json

Note created successfully

id · string<uuid>

The ID of the created note