Skip to main content

Add candidates to a flow

POST 

/v1/flows/:flow_id/candidates

Required scopeflows:writeWhat are scopes?

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​

Candidates processed