Investments

Restart an investor's journey

POST/investments/{id}/actions/restart
transactions:writerestart_investmentDestructive

Sends an investor back to the start of their journey and returns the investment. Deletes their journey events up to and including the current step in this tranche, clears form completions, revokes folder access and supersedes generated documents. The investment is recalculated: updated, or deleted when no events remain. Tokens act as staff, so the completed-investment block doesn't apply. Emits investment.updated or investment.deleted, notifies connected systems and audits. Nothing to remove returns it unchanged. Can't be undone.

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.

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.

Responses

200

The investment after the restart, as it was deleted when no events remain. Events on floating steps, other tranches and other investors are kept.

Investment
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "investor_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "external_investor_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "workflow_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "tranche_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "label": "string",
    "committed_amount": "string",
    "confirmed_amount": "string",
    "currency_code": "string",
    "last_journey_event_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00",
    "investor": {
      "name": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "string"
    }
  }
}
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 POST https://your-org-domain/kong/core/api/v2/investments/{id}/actions/restart\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"