Add candidates to a flow
POST/v1/flows/:flow_id/candidates
Adds up to 100 candidates. The response reports every outcome in request order, so the call returns 200 even when some candidates could not be added. On an active flow the candidates added start sending. Each candidate records who added them, and an account API key cannot stand in for a user, so a key must pass on_behalf_of.
Request
Responses
- 200
- 401
- 403
- 404
- 422
Candidates processed
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_duplicate_candidate-candidate_idslists a candidate twiceerr_candidate_not_found- a listed candidate is unknown, deleted, or not visible to the acting usererr_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