Activate a flow
POST/v1/flows/:id/activate
Starts a draft flow and begins its candidates. Consumes one flow credit. Candidates that could not be started are listed in results; the flow is active either way.
Request
Responses
- 200
- 401
- 403
- 404
- 422
Flow activated
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_already_active- the flow is already activeerr_flow_paused- the flow is paused; resume it insteaderr_flow_completed- the flow is completederr_flow_archived- the flow is archivederr_flow_no_active_steps- the flow has no active steps to senderr_credits_exhausted- the account has no flow credits lefterr_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