Add a form to an onboarding flow

POST/onboarding-flows/{onboarding_flow_id}/forms

onboarding:write create_onboarding_flow_form

Adds a new form to the flow and returns it with a Location. It always creates a new hidden form from name and description; it does not attach an existing form. The flow is locked while it runs. dry_run shows the result without saving it. Sends no email and emits no webhook. DELETE /onboarding-flows/{onboarding_flow_id}/forms/{id} undoes it.

Path parameters

onboarding_flow_idstring (uuid)Required#
The onboarding flow's id, a uuid. An unknown or deleted id 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.

Request body

application/json, required · OnboardingFlowFormCreate

namestringRequired#
The form's display name.
descriptionstring | null#
What the form asks for.

{
  "name": "Source of wealth",
  "description": "Where your funds come from."
}

Responses

201

The form was added to the flow.

OnboardingFlowForm

{
  "data": {
    "id": "6d8f3a52-9a41-4d6c-b7a1-2c9e5d1b7f33",
    "name": "Source of wealth",
    "description": "Where your funds come from.",
    "is_start": false,
    "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

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-flows/{onboarding_flow_id}/forms\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Source of wealth",
  "description": "Where your funds come from."
}'