Onboarding Sessions

Step an onboarding session back

POST/onboarding-sessions/{id}/actions/step-back
onboarding:writestep_back_onboarding_session

Removes the session's last route, clears the answers of the form the respondent leaves, and returns the session, in any state. A session with no routes yet returns 409 invalid_state; one whose current step is an appropriateness check or ends the flow without moving on is returned unchanged. dry_run shows the result without saving it. Sends the onboarding_session.stepped_back webhook. Cleared answers can't be restored.

Path parameters

  • idstring (uuid)Required#

    The onboarding session's id, a uuid. An unknown id, or a session you cannot see, 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.

Responses

200

The onboarding session, one step back.

OnboardingSession
{
  "data": {
    "id": "3f6e1c0a-8d52-4b7e-9a14-2c5d7e9b1f60",
    "flow_id": "48e0c1a6-6f3b-4d44-9d49-0a5a0b8f2d11",
    "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "status": "in_progress",
    "flow_test": false,
    "started_at": "2026-11-08T10:30:00Z",
    "completed_at": null,
    "verification": null,
    "created_at": "2026-11-08T10:30:00Z",
    "updated_at": "2026-11-08T10:30: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
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

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/onboarding-sessions/{id}/actions/step-back\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"