Skip to main content
POST
/
api
/
v1
/
external
/
companies
/
{companyId}
/
notes
Create Note
curl --request POST \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/notes \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "550e8400-e29b-41d4-a716-446655440200",
  "note": "Adjuster called the insured for clarification."
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440020"
}

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

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
​
entityId
string<uuid>
required

Parent entity identifier

​
note
string
required

The note body (must not be empty)

Response

Note created successfully

​
id
string<uuid>

The ID of the created note