Onboarding Sessions

Reset the sessions of an onboarding flow

POST/onboarding-sessions/actions/reset
onboarding:adminreset_onboarding_sessionsDestructive

Resets the visible sessions of a flow, those of organisation users only, and answers 202 with one job of type reset_onboarding_sessions. sessions is all, or in_progress for those neither completed nor expired. Each is fully reset; a versioned flow resets only each respondent's live real session (not a test run), giving one new session. The job's result is {reset_count}; cancel it with POST /jobs/{id}/actions/cancel. Sends an onboarding_session.reset webhook per session. dry_run: 202 with the count, no job. 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 · OnboardingSessionBulkReset

  • flow_idstring (uuid)Required#

    The flow whose sessions are reset. An unknown flow is 422 exists.

  • sessionsstringRequired#

    all resets every visible session of the flow; in_progress only those neither completed nor expired. A versioned flow takes only each respondent's live session.

    One of: all, in_progress
{
  "flow_id": "48e0c1a6-6f3b-4d44-9d49-0a5a0b8f2d11",
  "sessions": "in_progress"
}

Responses

202

The reset job was started, or with dry_run the number of sessions it would reset.

{
  "data": {
    "id": "7c1e4b2a-93d0-4f6a-8b15-0d2e6f8a4c39",
    "type": "reset_onboarding_sessions",
    "status": "queued",
    "progress": {
      "done": 0,
      "total": 42
    },
    "result": null,
    "error": null,
    "created_at": "2026-11-08T10:30:00Z",
    "updated_at": "2026-11-08T10:30:00Z",
    "completed_at": null
  }
}
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/onboarding-sessions/actions/reset\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "flow_id": "48e0c1a6-6f3b-4d44-9d49-0a5a0b8f2d11",
  "sessions": "in_progress"
}'