Step Config Overrides

Update a step config override

PATCH/step-config-overrides/{id}
transaction-workflows:writeupdate_step_config_overrideIdempotent

Replaces the override's config and returns it. Nothing else can change: to override a different requirement or trigger, create a new override. dry_run shows the result without saving it. It emits no webhook. Send the previous config to undo it.

Path parameters

  • 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

  • configobjectRequired#

    The configuration the deal uses instead of the workflow's, in the app's camelCase keys for the requirement or trigger's class_name, such as customFormId or portfolioAssetId. An unknown key returns 422 naming the keys the class takes.

{
  "config": {
    "classificationIds": [
      "class-y"
    ]
  }
}

Responses

200

The updated override.

StepConfigOverride
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "workflow_step_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "decorator_type": "requirement",
    "decorator_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "config": {},
    "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/step-config-overrides/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "config": {
    "classificationIds": [
      "class-y"
    ]
  }
}'