Investors

Update an investor

PATCH/investors/{id}

Changes the fields you send and returns the investor; omitted fields stay. status, sso_id and key_contact_id are read-only. A new email also rewrites the sign-in username; one another investor holds returns 422 unique, one over 53 characters 422. data_capture references must exist, else 422 exists. Emits investor.updated with the changed fields and the legacy user.* events; sends no email. Sending the old values undoes it.

Path parameters

  • 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.

Query parameters

  • dry_runboolean#

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

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · InvestorUpdate

  • emailstring (email)#

    The investor's new email. At most 53 characters. Another investor's email returns 422 unique. It also rewrites the sign-in username.

  • titlestring | null#

    Optional title, such as Mr, Ms or Dr.

  • first_namestring#

    The investor's first name.

  • last_namestring#

    The investor's last name.

  • external_idstring | null#

    The investor's id in your own system.

  • data_captureobject#

    Answers to your custom user data fields, keyed by field reference. Every reference must exist, else 422 exists.

{
  "title": "Ms",
  "first_name": "Augusta",
  "last_name": "King",
  "external_id": "CRM-2026-0042",
  "data_capture": {
    "tax_residency": "GB"
  }
}

Responses

200

The investor, as changed.

Investor
{
  "data": {
    "id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "first_name": "Augusta",
    "last_name": "King",
    "title": "Ms",
    "email": "ada.lovelace@example.com",
    "status": "active",
    "external_id": "CRM-1042",
    "sso_id": null,
    "key_contact_id": "1a2b3c4d-5e6f-4708-9a0b-1c2d3e4f5061",
    "invite": null,
    "two_factor_enabled": false,
    "last_login": "2026-06-16T09:12:00Z",
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-18T16:20: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/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "title": "Ms",
  "first_name": "Augusta",
  "last_name": "King",
  "external_id": "CRM-2026-0042",
  "data_capture": {
    "tax_residency": "GB"
  }
}'