Skip to main content
POST
Submit data to a source within a flow

Path Parameters

flow_id
string
required
read-only

The ID of the flow 24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

source_id
string
required
read-only

The ID of the source within the flow 24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

Body

The lead data to submit, as key-value pairs.

{key}
string

A dynamic set of key-value pairs representing lead data.

Response

The lead was processed. Check outcome: a lead rejected by the flow's acceptance criteria or by a cap is also reported here, with outcome: "failure" and the reason.

The result of submitting a lead to a flow source or to a router. Returned as JSON by default, or as XML or form encoding when requested via the Accept header. The response is produced by the source's inbound integration; this is the shape produced by the standard integrations.

outcome
enum<string>
required

Whether the flow accepted the lead. Check this field rather than the status code: a lead rejected by the flow's acceptance criteria or by a cap is still reported with 201.

Available options:
success,
failure,
error
reason
string | null

Why the lead was not accepted. Absent or null when the outcome is success.

Example:

"lead.phone must have valid format"

lead
object

The lead that was created.

price
number

The price of the lead. 0 when the lead was not accepted or the source has no pricing.

Example:

20