Skip to main content
GET
Ping 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"

Response

The ping was evaluated. Check outcome to see whether the flow would accept the lead.

The result of a ping. Same shape as a submission response, without the lead object because a ping does not create a lead.

outcome
enum<string>
required

Whether the flow would accept the lead.

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

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

Example:

"lead.phone must have valid format"

price
number

The price the flow would pay for the lead. 0 when it would not be accepted or the source has no pricing.

Example:

20