Add a step to a flow
POST/v1/flows/:flow_id/steps
Adds a step at the end of the flow, or at position. The steps already in the flow keep their own positions. A step sends as a user, and an account API key has no mailbox, so a key must pass on_behalf_of. The step then sends as sender_id, or as the acting user when that is omitted. Adding a step whose template is personalised to an active flow queues an AI message for every candidate already in it.
Request
Responses
- 201
- 401
- 403
- 404
- 422
Step created
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_template_id_required- the channel needs a template and none was givenerr_template_not_found- unknown templateerr_template_channel_mismatch- the template's channel is not the step's channelerr_mode_not_allowed_for_channel-manualwas sent on a LinkedIn channelerr_sender_not_found- unknown or inactivesender_iderr_sender_mailbox_not_connected- the sender has no mailbox connectederr_sender_email_delegation_disabled- the sender does not allow sending on their behalferr_no_access_to_shared_email- unknown shared inbox, or one the sender cannot send fromerr_invalid_channel_for_shared_email- a shared inbox was given on a channel other than emailerr_flow_step_limit_exceeded- the account's steps-per-flow limit is reachederr_flow_archived- the flow is archived and cannot be changederr_flow_completed- the flow is completed and cannot be changederr_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 actionerr_on_behalf_of_required- an account API key did not name a user to act as