External Investors

Create an external investor

POST/external-investors
transactions:writecreate_external_investor

Adds an investor who is not a platform user and returns it with a Location. Use its id as external_investor_id on POST /journey-events. It emits no webhook and sends no email. It has no delete, so rename it with PATCH /external-investors/{id} if you made a mistake. Use POST /investors to create a platform investor. Entrepreneur tokens get a 404, as external investors are hidden from them. It can't be undone.

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

  • namestringRequired#

    The investor's name.

{
  "name": "Harbour Family Office"
}

Responses

201

The external investor was created.

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
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 POST https://your-org-domain/kong/core/api/v2/external-investors\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Harbour Family Office"
}'