POST/v1/flows/{id}

Apply an operation to a flow

Applies an operation to a flow, such as moving an action or changing its status. The request body is optional; when supplied, its type and request must match a supported operation.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
idstringrequired
The flow identifier. Must contain exactly 21 alphanumeric characters.

Optional flow operation. When supplied, include an operation type and the corresponding request object.

requestobjectrequired
typestringrequired
Allowed:MOVE_ACTION

1 status code
200Returns the result of the operation applied to the flow.

Error handling

The id path parameter must contain exactly 21 alphanumeric characters and identify the flow. When you provide an operation body, use a supported type and its corresponding request; for example, MOVE_ACTION requires name and newParentStep, while CHANGE_STATUS requires status.