Journey Events

Update a journey event

PATCH/journey-events/{id}
transactions:writeupdate_journey_eventIdempotent

Replaces what the event recorded (event_data) and returns the event. The investment's amounts are recalculated from its events. The step's requirements and triggers run again (see 422, 409, 502), so a webhook, Portfolio post or branch move can happen again; the same event_data changes nothing. It can't move the event to another step. It emits no webhook but notifies staff and the investor. dry_run shows the result without saving it. Sending the previous event_data restores the data, not what triggers did.

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

  • event_dataobjectRequired#

    What the event records. Amounts are decimal strings and currency_code is ISO 4217; they update the investment. Keys must be the step's fields, keys the event already holds, note, removal_data, historic_data, portfolio_unit_value or portfolio_total_units; others return 422.

{
  "event_data": {
    "confirmed_amount": "250000.00",
    "currency_code": "GBP"
  }
}

Responses

200

The updated journey event.

JourneyEvent
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "kind": "jump",
    "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "investment_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "tranche_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "investor_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "external_investor_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "from_step_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "from_step_label": "string",
    "to_step_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "to_step_label": "string",
    "initial": true,
    "event_data": {},
    "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
409

The workflow can't be run (conflict), for the reasons POST /journey-events gives other than those about jumps.

Error
422

validation_failed, with every problem in details: a key the step doesn't record (rule: prohibited), an amount in a currency other than the investment's (rule: currency), or a requirement the event no longer meets, checked as when it was recorded (rule: step_requirement on to_step_id).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error
502

upstream_error: a service the workflow calls failed, either for a trigger (such as a webhook receiver refusing the call, attachments refusing a generated document or a folder grant, or Portfolio refusing an asset lookup or a transaction) or while Sumsub resets an expired proof of address. Nothing is written, and calls already made that can be undone are undone.

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/journey-events/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "event_data": {
    "confirmed_amount": "250000.00",
    "currency_code": "GBP"
  }
}'