Skip to main content
PATCH
/
api
/
v1
/
external
/
companies
/
{companyId}
/
notes
/
{noteId}
Update Note
curl --request PATCH \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/notes/{noteId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "Updated after follow-up call with the insured."
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440020",
  "entityType": "Event",
  "entityId": "550e8400-e29b-41d4-a716-446655440200",
  "note": "Updated after follow-up call with the insured.",
  "createdAt": "2026-01-15T10:30:00.000Z",
  "createdBy": "550e8400-e29b-41d4-a716-446655440999",
  "createdByName": "Jane Adjuster",
  "updatedAt": "2026-01-20T14:00:00.000Z",
  "updatedBy": "550e8400-e29b-41d4-a716-446655440999"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

​
companyId
string<uuid>
required

Company identifier

​
noteId
string<uuid>
required

Note identifier

Query Parameters

​
entityType
enum<string>
required

Parent entity type (PascalCase). Selects the per-entity permission enforced for the request and scopes the note to its parent entity.

Available options:
Event,
Exposure,
Quote,
Submission,
Person,
Organization,
Policy

Body

application/json
​
note
string
required

The new note body (must not be empty)

Response

Note updated successfully

A note attached to a top-level Field Model V1 entity. Notes are simple text records scoped to a parent entity (identified by entityType + entityId). createdByName is resolved from the users table for display.

​
id
string<uuid>
required

Note identifier

​
entityType
enum<string>
required

The parent entity type (PascalCase)

Available options:
Event,
Exposure,
Quote,
Submission,
Person,
Organization,
Policy
​
entityId
string<uuid>
required

The parent entity identifier

​
note
string
required

The note body

​
createdAt
string<date-time>
required

When the note was created

​
updatedAt
string<date-time>
required

When the note was last updated

​
createdBy
string | null

User ID who created the note

​
createdByName
string | null

Display name of the creating user, resolved for display only

​
updatedBy
string | null

User ID who last updated the note