Create a transaction workflow

POST/transaction-workflows

transaction-workflows:write create_transaction_workflow

Creates a draft workflow and returns it with a Location. Like the app, it starts with the protected committed and completed steps a deal needs, with their fields (effective_date, currency_code, the amount, note, removal_data); completed is for internal users only. Send name, label or both: name defaults to custom_ and the label, label to name. It isn't the default. Add steps with POST /workflow-steps. It emits no webhook, and DELETE /transaction-workflows/{id} undoes it.

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

namestring | null#
The machine name. Defaults to custom_ and the label, without spaces or punctuation.
labelstring | null#
The name people see. Defaults to the name.
descriptionstring | null#
What the workflow is for.
statusstring#
draft or published. New workflows are draft unless you say otherwise.
One of: draft, publishedDefault: "draft"

{
  "name": "standard-equity",
  "label": "Standard equity",
  "description": "Commit, confirm, then fund."
}

Responses

201

The workflow was created.

TransactionWorkflow

{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "label": "string",
    "description": "string",
    "status": "draft",
    "is_default": true,
    "kyc_check_step_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "steps": [
      {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "workflow_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "name": "string",
        "label": "string",
        "type": "string",
        "kind": "linear",
        "description": "string",
        "is_protected": true,
        "is_floating": true,
        "order": 1,
        "has_custom_form": true,
        "is_internal_only": true,
        "show_default_internal_message": true,
        "document_upload": {},
        "minimum_investment": {},
        "document_release": {},
        "webhook": {},
        "posts_to_portfolio": true,
        "info_banner": {},
        "requirements": [],
        "triggers": [],
        "created_at": "2026-06-12T10:00:00+00:00",
        "updated_at": "2026-06-12T10:00:00+00:00"
      }
    ],
    "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

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/transaction-workflows\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "standard-equity",
  "label": "Standard equity",
  "description": "Commit, confirm, then fund."
}'