Onboarding Flows

Add a classification to an onboarding flow

POST/onboarding-flows/{onboarding_flow_id}/classifications

Links one of your organisation's classifications to the flow and returns the link with a Location. A classification that is not yours, or does not exist, returns 422 exists. Adding one the flow already has returns 200 with the existing link and creates nothing. dry_run shows the result without saving it. Sends no email and emits no webhook. DELETE /onboarding-flows/{onboarding_flow_id}/classifications/{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 · OnboardingFlowClassificationCreate

  • classification_idintegerRequired#

    The classification to award, one of your organisation's. Any other id is 422 exists.

{
  "classification_id": 42
}

Responses

200

The classification was already linked, so nothing changed. This is the existing link.

OnboardingFlowClassification
{
  "data": {
    "id": "c3a5e0d1-7b24-4f19-8e66-1a9d2b4c6e77",
    "classification_id": 42,
    "created_at": "2026-11-08T10:30:00Z",
    "updated_at": "2026-11-08T10:30:00Z"
  }
}
201

The classification was linked to the flow.

OnboardingFlowClassification
{
  "data": {
    "id": "c3a5e0d1-7b24-4f19-8e66-1a9d2b4c6e77",
    "classification_id": 42,
    "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}/classifications\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "classification_id": 42
}'