Investor Notes

Update an investor's note

PATCH/investors/{investor_id}/notes/{id}

Changes the title or body of a note and returns it. Any holder of notes:write in your organisation can change any of its notes. A body that changes nothing returns the note unchanged and emits nothing. dry_run shows the result without saving it. Emits investor_note.updated; no email. Sending the previous values undoes it.

Path parameters

  • investor_idstring (uuid)Required#

    The investor's id, a uuid. An unknown investor, or one outside the token's organisation and its client organisations, returns 404.

  • idintegerRequired#

    The note's id. Notes are keyed by integer ids, not UUIDs: a whole number from 1 to 2147483647.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · InvestorNoteUpdate

  • titlestring | null#

    The new heading. Null clears it.

  • bodystring#

    The new note text, at most 16000 characters, not blank.

{
  "body": "Discussed onboarding and fees."
}

Responses

200

The updated note.

InvestorNote
{
  "data": {
    "id": 4210,
    "title": "Kickoff call",
    "body": "Discussed onboarding next steps.",
    "author_id": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-15T10:30:00Z"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/investors/{investor_id}/notes/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "body": "Discussed onboarding and fees."
}'