Patch a workflow action execution
Updates the status (and optional reason) of a workflow action execution, Requires the WORKFLOW_ACTION_EXECUTION.UPDATE permission.
Authentication
X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
version
version
resourceId
The ID of the resource to be requested.
Headers
x-platform-id
Platform ID.
Request
This endpoint expects an object.
workflow_action_id
The workflow action this execution row belongs to.
workflow_action
The expanded workflow action this execution row belongs to.
workflow_trigger_id
The workflow trigger that produced this execution row.
workflow_trigger
The expanded workflow trigger that produced this execution row.
status
Status of this execution row.
Allowed values:
reason
Optional reason describing why the action ended in this status.
conditions_result_tree
The evaluated condition result tree captured when the workflow was triggered, showing why the action did or did not execute.
Response
OK
object_type
id
workflow_action_id
The workflow action this execution row belongs to.
workflow_action
The expanded workflow action this execution row belongs to.
workflow_trigger_id
The workflow trigger that produced this execution row.
workflow_trigger
The expanded workflow trigger that produced this execution row.
workflow_id
The workflow this execution belongs to. Derived from the workflow trigger.
status
Status of this execution row.
Allowed values:
reason
Optional reason describing why the action ended in this status.
conditions_result_tree
The evaluated condition result tree captured when the workflow was triggered, showing why the action did or did not execute.
created_at
Date time when this execution row was created.
updated_at
Date time when this execution row was last updated.
Errors
401
Unauthorized Error
403
Forbidden Error