Approval Workflow Models

Replace a legacy or expanded approval workflow definition

Changed on
put/approval-workflows/condition-models/v2/{approval_workflow_id}

Request

Path parameters

approval_workflow_idstring uuid required

Request body

namestring required
type'JOURNAL_ENTRY' | 'CONTRACT' | 'INVOICE' | 'BILL' | 'CHARGE' | 'CHARGE_REVERSAL' | 'REIMBURSEMENT' required

The kind of record a workflow applies to. Contract and Invoice are retained for backward-compatible reads but cannot be updated through this endpoint.

activeboolean required

Required, and must equal the workflow's current value — activation is a dedicated operation in Rillet, so a definition update never changes it. Read the workflow first if you are unsure.

methodsApprovalWorkflowMethod[] required

Only ["IN_APP"] is accepted today: EMAIL and SLACK deliver nothing, so they are rejected rather than stored.

submission_sourcesApprovalWorkflowConfigurableSubmissionSource[]
condition_model_version2 required
deadline_daysinteger nullable

Response

Success

idstring uuid required
namestring required
type'JOURNAL_ENTRY' | 'CONTRACT' | 'INVOICE' | 'BILL' | 'CHARGE' | 'CHARGE_REVERSAL' | 'REIMBURSEMENT' required

The kind of record a workflow applies to. Contract and Invoice are retained for backward-compatible reads but cannot be updated through this endpoint.

activeboolean required

Only active workflows are evaluated. Read-only here: a workflow is activated and deactivated in Rillet, so this value can change without a definition update.

priorityinteger required

Evaluation order among the active workflows of the same type, ascending and zero-based — the first workflow whose conditions match is the one applied, and later ones are skipped. Assigned by the server: a workflow is put last when created, and again when reactivated. Not necessarily unique; ties are resolved by id.

methodsApprovalWorkflowMethod[] required

How approvers are asked to act. IN_APP is the only method Rillet acts on today; EMAIL and SLACK can appear on workflows configured before they were withdrawn, and no notification is delivered for them.

submission_sourcesApprovalWorkflowSubmissionSource[]
updated_atstring date-time required

ISO 8601 timestamp in UTC timezone (must end with 'Z'). Covers activation and reordering as well as definition changes.

condition_model_version2 required
deadline_daysinteger nullable

Changes