Skip to content

Answer a human-approval step with changes requested

POST
/workflows/executions/request-changes

The THIRD outcome of a human-approval step, beside approve and reject.

Approve and reject are terminal for the paused node. This one is not: it sends the run down the revise branch carrying the reviewer’s words, so the workflow gets another attempt instead of ending.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
feedback
required

REQUIRED and non-blank. It is the value the revise branch reads as ${<human_node>.feedback} - an empty one sends the workflow down the revise path with nothing to revise against.

string
>= 1 characters <= 2000 characters
requested_by
required

Who is asking for changes.

string
workflow_id
required

The workflow the run belongs to.

string

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string