Archive a step
POST/v1/flows/:flow_id/steps/:step_id/archive
Stops a step from running without removing it or what it already sent. Its place in the sequence is kept. Only an active step on a live flow can be archived.
Request
Responses
- 200
- 401
- 403
- 404
- 422
Step archived
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), or the step is not in the flow (err_step_not_found).
Validation failed. Error codes:
err_step_not_archivable- the step is already archivederr_flow_completed- the flow is completederr_flow_archived- the flow is archivederr_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