Skip to content

Decide Desk Play Approval

POST
/desk/plays/approvals/{execution_id}/decide

Approve or reject one paused run, AS THIS REP.

Approving RESUMES the run, and what it then does is whatever the workflow does - which can include sending. The identity matters: the workflow’s author may have named an approver list, and a caller not on it gets a 403 rather than a silent no-op.

403 means “not your decision to make”, 404 means the run is no longer waiting. Neither is a retryable error.

Authorizations

Parameters

Path Parameters

execution_id
required

Paused workflow execution id.

string

Paused workflow execution id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Approve or reject one paused workflow run.

decision is CLOSED to the two values the engine accepts. A free string would reach the engine and come back as a 502, which reads like an outage rather than a typo.

object
decision
required
string
Allowed values: approve reject
note
Any of:
string
<= 2000 characters

Responses

200

Successful Response

object
data
required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

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