Create an edit request

POST/edit-requests

Records that an investor wants a journey event changed and returns the request, pending, with a Location. The event must be one you can see; an event you can't see, a deleted one or an unknown id returns 422 exists on journey_event_id. It writes an audit entry with the token's user as the actor, and emits no webhook or email. Staff get an in-app notification only when the investor asks for themselves. It can't be deleted. Use POST /edit-requests/{id}/actions/mark-received once it is acknowledged.

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

journey_event_idstring (uuid)Required#
The journey event the investor wants changed.
reasonstringRequired#
Why the change is asked for.
typestring | null#
What kind of change is asked for, such as amount.

{
  "journey_event_id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
  "reason": "Committed amount entered incorrectly",
  "type": "amount"
}

Responses

201

The edit request was created.

EditRequest

{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "journey_event_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",
    "type": "string",
    "reason": "string",
    "status": "pending",
    "received_at": "2026-06-12T10:00:00+00:00",
    "accepted_at": "2026-06-12T10:00:00+00:00",
    "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 POST https://your-org-domain/kong/core/api/v2/edit-requests\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "journey_event_id": "4e5f6a7b-8c9d-4e0f-8a1b-2c3d4e5f6a7b",
  "reason": "Committed amount entered incorrectly",
  "type": "amount"
}'