External Investors

Update an external investor

PATCH/external-investors/{id}
transactions:writeupdate_external_investorIdempotent

Changes the fields you send and returns the external investor. dry_run shows the result without saving it. It emits no webhook. A new name is audited, with the old one, on every deal the investor is on, and staff on each of those deals are notified and emailed. It can't be undone, so send the old name to change it back.

Path parameters

  • idstring (uuid)Required#

    The record's id.

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

  • namestring#

    The investor's name.

{
  "name": "Harbour Family Office Ltd"
}

Responses

200

The updated external investor.

ExternalInvestor
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
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/external-investors/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Harbour Family Office Ltd"
}'