Complete a flow
POST/v1/flows/:id/complete
Ends a flow and stops every candidate still in flight. Cannot be undone. A flow that is already completed is left as it is.
Request
Responses
- 200
- 401
- 403
- 404
- 422
Flow updated
Missing or invalid bearer token.
The public API is not enabled for this account (err_feature_not_enabled), the acting user is not allowed to edit this flow, or the API key lacks the flows:write scope (err_insufficient_scope).
Flow not found (err_flow_not_found).
Validation failed. Error codes:
err_flow_not_completable- only an active or paused flow can be completederr_on_behalf_of_not_allowed- a personal access token passed another user's IDerr_user_not_found-on_behalf_ofis not an active user in the accounterr_on_behalf_of_forbidden- that user is not allowed to perform this action