SaveDraft

PUT

/api/v1/t/{tenant}/workflows/definitions/{definitionId}/draft

curl --request PUT \
  --url https://example.com/api/v1/t/example/workflows/definitions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/draft \
  --header 'Content-Type: application/json' \
  --data '{ "version": 1, "basedOnVersion": 1, "definition": { "schemaVersion": 1, "startStep": "example", "steps": [ { "kind": "humanTask", "taskKind": "Approve", "assignees": [ { "when": { "kind": "compare", "field": "example", "value": "LastTaskOutcome", "operator": "EqualTo", "constants": [ "example" ], "output": { "step": "example", "key": "example" } }, "assignee": { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table": "example" } } ], "fallback": { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table": "example" }, "options": { "remindAfterWorkingDays": 1, "escalateAfterWorkingDays": 1, "escalationTarget": { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table": "example" }, "excludeRequester": true, "excludeActorsOfSteps": [ "example" ], "pickFile": false, "deadline": { "value": { "step": "example", "key": "example" }, "dateField": "example", "remindBeforeWorkingDays": 1, "escalateBeforeWorkingDays": 1 } }, "next": "example", "onRejected": "example", "requiredFields": { "fields": [ "example" ], "requireComment": true }, "parallelApproval": { "mode": "All", "approvers": [ { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table": "example" } ], "quorum": 1 }, "name": "example", "label": "example" } ], "fields": [ { "key": "example", "kind": "Text", "labelDe": "example", "labelEn": "example", "documentTypeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "options": [ { "key": "example", "labelDe": "example", "labelEn": "example" } ] } ], "deadlineTrigger": { "stage": "Reminder", "kind": "End", "ruleKey": "example" } }, "form": { "positions": { "additionalProperty": { "x": 1, "y": 1 } }, "invoiceSettings": { "suggestAllocation": true, "collectiveApproval": { "enabled": true, "cap": 1 } }, "dataTables": [ { "key": "example", "labelDe": "example", "labelEn": "example", "columns": [ { "key": "example", "labelDe": "example", "labelEn": "example", "kind": "Text", "isKey": true } ], "rows": [ {} ] } ], "name": "example", "triggerDocumentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "fromProposal": false }'

Parameters

Path Parameters

tenant

required

string

Tenant slug

definitionId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

version

required

null | integer format: uint32

basedOnVersion

required

integer format: int32

definition

required

object

schemaVersion

required

integer format: int32

startStep

required

string

steps

required

Array<object>

Any of: discriminator: kind

object

object

kind

required

string

Allowed values: humanTask

taskKind

required

Allowed values: Approve Review Acknowledge Fix Capture SignatureFieldReview

assignees

required

Array<object>

object

when

required

One of:

null

null

object

Any of: discriminator: kind

object

object

kind

required

string

Allowed values: compare

field

required

null | string

value

required

One of:

null

null

unknown

Allowed values: LastTaskOutcome DocumentTags DocumentFiles InvoiceCostCenter

operator

required

Allowed values: EqualTo NotEqualTo LessThan LessOrEqual GreaterThan GreaterOrEqual IsEmpty IsOneOf

constants

required

Array<string>

output

One of:

null

null

object

object

step

required

string

key

required

string

object

object

kind

required

string

Allowed values: and

conditions

required

Array<object> recursive

object

object

kind

required

string

Allowed values: or

conditions

required

object

object

kind

required

string

Allowed values: tableLookup

table

required

string

keyField

required

string

column

required

null | string

operator

required

One of:

null

null

unknown

Allowed values: EqualTo NotEqualTo LessThan LessOrEqual GreaterThan GreaterOrEqual IsEmpty IsOneOf

constants

required

assignee

required

object

kind

required

Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner

userId

null | string format: uuid

roleId

null | string format: uuid

table

null | string

fallback

required

object

kind

required

Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner

userId

null | string format: uuid

roleId

null | string format: uuid

table

null | string

options

required

object

remindAfterWorkingDays

required

null | integer format: int32

escalateAfterWorkingDays

required

null | integer format: int32

escalationTarget

required

One of:

null

null

object

object

kind

required

Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner

userId

null | string format: uuid

roleId

null | string format: uuid

table

null | string

excludeRequester

required

boolean

excludeActorsOfSteps

required

Array<string>

pickFile

boolean

deadline

One of:

null

null

object

object

value

One of:

null

null

object

object

step

required

string

key

required

string

dateField

null | string

remindBeforeWorkingDays

null | integer format: int32

escalateBeforeWorkingDays

null | integer format: int32

next

required

string

onRejected

null | string

requiredFields

One of:

null

null

object

object

fields

required

Array<string>

requireComment

required

boolean

parallelApproval

One of:

null

null

object

object

mode

required

Allowed values: All Any Quorum

approvers

required

Array<object>

object

kind

required

Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner

userId

null | string format: uuid

roleId

null | string format: uuid

table

null | string

quorum

null | integer format: int32

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: condition

branches

required

Array<object>

object

when

required

Any of: discriminator: kind

object

object

kind

required

string

Allowed values: compare

field

required

null | string

value

required

One of:

null

null

unknown

Allowed values: LastTaskOutcome DocumentTags DocumentFiles InvoiceCostCenter

operator

required

Allowed values: EqualTo NotEqualTo LessThan LessOrEqual GreaterThan GreaterOrEqual IsEmpty IsOneOf

constants

required

Array<string>

output

One of:

null

null

object

object

step

required

string

key

required

string

object

object

kind

required

string

Allowed values: and

conditions

required

Array<object> recursive

object

object

kind

required

string

Allowed values: or

conditions

required

object

object

kind

required

string

Allowed values: tableLookup

table

required

string

keyField

required

string

column

required

null | string

operator

required

One of:

null

null

unknown

Allowed values: EqualTo NotEqualTo LessThan LessOrEqual GreaterThan GreaterOrEqual IsEmpty IsOneOf

constants

required

next

required

string

default

required

string

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: timer

next

required

string

days

null | integer format: int32

dateField

null | string

daysBefore

integer format: int32

0

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: notification

next

required

string

recipients

required

Array<object>

object

kind

required

Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner

userId

null | string format: uuid

roleId

null | string format: uuid

table

null | string

notice

required

Allowed values: ForInformation

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: filing

next

required

string

fileId

required

null | string format: uuid

tagIds

required

Array<string>

byField

One of:

null

null

object

object

fileTypeId

required

string format: uuid

keyField

required

string

documentField

required

string

create

required

boolean

nameField

null | string

onCreated

null | string

onNoFile

null | string

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: aiAction

next

required

string

action

required

Allowed values: SuggestApprover CheckDuplicate Summarize CheckPlausibility ClassifyAgain ExtractAgain

allowConfidential

boolean

onSkipped

null | string

deviationPercent

null | integer format: int32

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: end

outcome

required

Allowed values: Running Approved Rejected Completed Cancelled Failed

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: script

script

required

string

hook

required

Allowed values: OnDocumentArrived BeforeApproval OnApproved OnRejected OnTimer

inputs

required

Array<object>

object

kind

required

Allowed values: Field Source Table

key

required

string

type

One of:

null

null

unknown

Allowed values: Text Number Money Date Boolean Enumeration Reference

returns

required

Array<object>

object

key

required

string

type

required

Allowed values: Text Number Money Date Boolean Enumeration Reference

values

required

Array<string>

branch

required

null | string

exits

required

Array<object>

object

value

required

string

next

required

string

next

required

string

onFailure

null | string

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: setField

assignments

required

Array<object>

object

field

required

string

source

required

Allowed values: Constant Field DatePlusDays Sum Difference TableLookup

value

null | string

operands

Array<string> | null

days

null | integer format: int32

lookup

One of:

null

null

object

object

table

required

string

keyField

required

string

column

required

string

next

required

string

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: aiCustom

instruction

required

string

fields

required

Array<string>

readText

required

boolean

answer

required

Allowed values: YesNo Choice Number Text

choices

required

Array<string>

next

required

string

suggestField

null | string

allowConfidential

boolean

onSkipped

null | string

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: wait

waitFor

required

Allowed values: FieldSet Document StartedWorkflow

field

required

string

documentTypeId

required

null | string format: uuid

otherField

required

null | string

timeoutDays

required

integer format: int32

next

required

string

onTimeout

required

string

startStep

null | string

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: startWorkflow

definitionId

required

string format: uuid

next

required

string

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: externalEmail

templateId

required

string format: uuid

recipient

required

Allowed values: Vendor Field Fixed

next

required

string

onSkipped

required

string

language

string

default: de

recipientField

null | string

allowConfidential

boolean

allowAiRecipient

boolean

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: webhook

endpoint

required

string

event

required

string

fields

required

Array<string>

next

required

string

onSkipped

required

string

allowConfidential

boolean

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: skonto

leadDays

required

integer format: int32

next

required

string

onMissed

required

string

onNone

required

string

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: invoiceCheck

check

required

Allowed values: MandatoryDetails OrderMatch ContractMatch

next

required

string

onDeviation

required

string

onNotFound

null | string

order

One of:

null

null

object

object

invoiceField

required

string

orderTypeId

required

string format: uuid

orderField

required

string

tolerancePercent

null | number format: double

toleranceAmount

null | number format: double

invoiceVendorField

null | string

orderVendorField

null | string

deliveryNoteWaitStep

null | string

contract

One of:

null

null

object

object

contractTypeId

required

string format: uuid

invoiceReferenceField

null | string

contractReferenceField

null | string

amountField

string

default: totalGross

tolerancePercent

number format: double

default: 10

name

required

string

label

null | string

object

object

kind

required

string

Allowed values: signature

signers

required

Array<object>

object

kind

required

Allowed values: Member Requester External

label

required

string

userId

null | string format: uuid

firstNameField

null | string

lastNameField

null | string

emailField

null | string

mobileField

null | string

level

required

Allowed values: Ses Aes Qes

fieldMode

required

Allowed values: TypeTemplate Detect ReviewBeforeSend

reviewer

required

object

kind

required

Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner

userId

null | string format: uuid

roleId

null | string format: uuid

table

null | string

next

required

string

onDeclined

required

string

onExpired

required

string

onSkipped

required

string

ordered

boolean

default: true

expiryDays

integer format: int32

default: 14

allowConfidential

boolean

language

string

default: de

name

required

string

label

null | string

fields

Array<object> | null

object

key

required

string

kind

required

Allowed values: Text Number Date Money Enumeration

labelDe

required

string

labelEn

required

string

documentTypeIds

required

Array<string>

options

Array<object> | null

object

key

required

string

labelDe

required

string

labelEn

required

string

deadlineTrigger

One of:

null

null

object

object

stage

required

Allowed values: Reminder Due

kind

One of:

null

null

unknown

Allowed values: End Notice DateField Obligation FollowUp

ruleKey

null | string

form

required

object

positions

required

object

key

additional properties

object

x

required

number format: double

y

required

number format: double

invoiceSettings

required

One of:

null

null

object

object

suggestAllocation

required

boolean

collectiveApproval

required

object

enabled

required

boolean

cap

required

null | number format: double

dataTables

Array<object> | null

object

key

required

string

labelDe

required

string

labelEn

required

string

columns

required

Array<object>

object

key

required

string

labelDe

required

string

labelEn

required

string

kind

required

Allowed values: Text Number Money Date Boolean

isKey

required

boolean

rows

required

Array<object>

object

name

required

string

triggerDocumentTypeId

required

null | string format: uuid

fromProposal

boolean

Responses

200

OK

Media typeapplication/json

object

version

required

integer format: uint32

savedAt

required

string format: date-time

Example^generated

{
  "version": 1,
  "savedAt": "2026-04-15T12:00:00Z"
}

400

Bad Request

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

409

Conflict

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

413

Payload Too Large

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

415

Unsupported Media Type

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}