Classification Requirements

Update a classification requirement

PATCH/workflow-steps/{workflow_step_id}/classification-requirements/{id}
transaction-workflows:writeupdate_classification_requirementIdempotent

Changes the fields you send and returns the requirement. Sending classification_ids replaces the whole list. dry_run shows the result without saving it. It emits no webhook, and sending the previous classification_ids undoes it.

Path parameters

  • workflow_step_idstring (uuid)Required#

    The workflow step the requirements belong to.

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · ClassificationRequirementUpdate

  • classification_idsinteger[]#

    The investor needs at least one of these classifications. They are classification ids, so they are integers. Each can appear once.

  • labelstring#

    What the investor is told the step checks.

  • error_messagestring | null#

    What the investor is told when the check fails.

  • enabledboolean#

    Whether the step enforces this requirement. New requirements are not enforced unless you say so.

{
  "enabled": true
}

Responses

200

The updated requirement.

ClassificationRequirement
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "workflow_step_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "classification_ids": [
      1
    ],
    "label": "string",
    "error_message": "string",
    "enabled": true,
    "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 PATCH https://your-org-domain/kong/core/api/v2/workflow-steps/{workflow_step_id}/classification-requirements/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "enabled": true
}'