Flows

A flow defines how leads are processed. A flow can include a range of actions, including validation, normalization, and distribution, that are applied to leads as they move through the flow.

Each step in the flow is represented by a "node," which can perform a specific action or set of actions on the lead. For example, a node might validate the lead's phone number or email address, normalize the lead's data, or distribute the lead to a specific destination based on predefined rules.

Flows can be customized to meet the specific needs of your business, and LeadConduit offers a range of pre-built templates and tools to help you create a flow that fits your unique requirements.

Overall, flows are a powerful feature of the LeadConduit platform that enable you to streamline lead processing, automate lead distribution, and improve lead quality, all while maximizing your ROI.

Free accounts do not have access to Flows (https://app.leadconduit.com/flows) and will receive a 401 (Unauthorized) error when trying to access it

Destination

An internal representation of a Prismatic instance.

name
string

A customizable name of the destination.

integration_name
string

The name of the integration as published in the Marketplace.

integration_icon_url
string

Pre-signed URL for the integration icon.

instance_id
string

The Prismatic instance ID.

Array of objects

A list of actions available in the configured instance. These map to Prismatic "flows" within an instance.

object

Contains data on flows in which the destination is used. This field is optional and is only included when the include=flow_usages query parameter is included in the request.

{
  • "name": "Salesforce",
  • "integration_name": "string",
  • "integration_icon_url": "string",
  • "instance_id": "string",
  • "actions": [
    • {
      • "name": "Add Lead",
      • "action_id": "Add Lead",
      • "webhook_url": "string"
      }
    ],
  • "flow_usages": {
    • "count": 0,
    • "flows": [
      • {
        • "id": "5fd4371e940df5a34a3888b2",
        • "name": "string"
        }
      ]
    }
}

Flow

id
string (ID) ^[0-9a-fA-F]{24}$

some custom description

name
required
string non-empty

The name of the flow

errors
object

Errors preventing this flow from being saved

enabled
required
boolean

Disabling a flow will prevent any processing of lead submissions. Submission will result in an error outcome.

fields
required
Array of strings

The list of fields (IDs) representing the lead to be processed by this flow.

null or Array of objects (Caps)
object (acceptance-criteria)

A submitted lead that fails an acceptance criteria rule will be rejected. Lead submission will result in a failure outcome.

object (Pricing)

This pricing configuration applies to all leads submitted to this flow. Pricing determines the value of the purchase_price and cost property on the source event recorded when a lead is submitted.

Each price is evaluated and the last price for which all rules match will determine the amount used for the purchase_price and cost. If none of these prices match for a particular lead, source pricing will be evaluated. If no price matches, the price properties on the source event will be set to 0.

object (ListChecks)

Check the lead against SuppressionList lists to see if it's a duplicate, and existing customer, or is on the do-not-call list.

Array of objects (Destination)
required
Array of objects (Source)
required
Array of Filter Step (object) or Recipient Step (object)
ping_enabled
boolean
Default: false
Array of objects (PingLimits)
object (PricingServiceConfiguration)

The configuration required on a Source or Flow to define a Pricing Service for lead pricing.

object (Firehose)
created_at
string <date-time> (Timestamp)
updated_at
string <date-time> (Timestamp)
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "Sales Leads",
  • "errors": { },
  • "enabled": true,
  • "fields": [
    • "first_name",
    • "last_name",
    • "email",
    • "phone_1",
    • "address_1",
    • "city",
    • "state",
    • "postal_code",
    • "trustedform_cert_url"
    ],
  • "caps": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "id": "1aacd0",
      • "op": "and",
      • "rules": [
        • {
          • "id": "1aacd0",
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "pricing": {
    • "override": true,
    • "prices": [
      • {
        • "id": { },
        • "amount": 0,
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ]
    },
  • "list_checks": {
    • "duplicate": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "existing_customer": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "dnc": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      }
    },
  • "destinations": [
    • {
      • "name": "Salesforce",
      • "integration_name": "string",
      • "integration_icon_url": "string",
      • "instance_id": "string",
      • "actions": [
        • {
          • "name": "Add Lead",
          • "action_id": "Add Lead",
          • "webhook_url": "string"
          }
        ],
      • "flow_usages": {
        • "count": 0,
        • "flows": [
          • {
            • "id": "5fd4371e940df5a34a3888b2",
            • "name": "string"
            }
          ]
        }
      }
    ],
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "5fd4371e940df5a34a3888b2",
        • "name": "string",
        • "time_zone": "America/New_York"
        },
      • "acceptance_criteria": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "outcome": "failure",
        • "reason": "string"
        },
      • "feedback": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "id": "1aacd0",
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          }
        },
      • "caps": { },
      • "ping_limits": [
        • {
          • "id": "5fd4371e940df5a34a3888b2",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "credential_id": "5fd4371e940df5a34a3888b2",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "pricing_service": {
        • "service_id": "5fd4371e940df5a34a3888b2",
        • "fallback_price": 0
        },
      • "enabled": true,
      • "authentication_required": true
      }
    ],
  • "steps": [
    • {
      • "type": "filter",
      • "id": "1aacd0",
      • "description": "string",
      • "notes": "string",
      • "reason": "string",
      • "outcome": "string",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "enabled": true
      }
    ],
  • "ping_enabled": false,
  • "ping_limits": [
    • {
      • "id": "5fd4371e940df5a34a3888b2",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "pricing_service": {
    • "service_id": "5fd4371e940df5a34a3888b2",
    • "fallback_price": 0
    },
  • "firehose": {
    • "credential_id": "5fd4371e940df5a34a3888b2",
    • "enabled": true,
    • "bucket": "string",
    • "prefix": "string",
    • "services": {
      • "aws": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        },
      • "azure": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        }
      }
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Meta

enabled
required
boolean
required
object
required
object
required
object
object
object (acceptance-criteria)

A submitted lead that fails an acceptance criteria rule will be rejected. Lead submission will result in a failure outcome.

object
required
Array of objects
flow_pricing
object
source_pricing
object
pingable
required
boolean
ping_enabled
required
boolean
updated_at
required
string <date-time>
authorized_account
required
boolean
{
  • "enabled": true,
  • "account": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "ActiveProspect, Inc."
    },
  • "flow": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "string"
    },
  • "source": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "string",
    • "authentication_required": false
    },
  • "hours_of_operation": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "id": "1aacd0",
      • "op": "and",
      • "rules": [
        • {
          • "id": "1aacd0",
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "flow_acceptance_criteria": { },
  • "params": [
    • {
      • "name": "first_name",
      • "label": "First Name",
      • "description": "First name",
      • "type": "first_name",
      • "variable": "first_name",
      • "examples": [
        • "Mike",
        • "Robert",
        • "Janet"
        ],
      • "required": "no"
      }
    ],
  • "flow_pricing": null,
  • "source_pricing": null,
  • "pingable": true,
  • "ping_enabled": false,
  • "updated_at": "2025-03-20T15:06:01.777Z",
  • "authorized_account": true
}

List all destinations configured for the account

The /destinations resource is used to query destinations which have been configured in the LeadConduit app. If no destinations are configured for your account, this resource will return an empty array. Destinations returned from this endpoint can be added to flows.

SecurityAPIKey
Request
query Parameters
include
string

Additional properties to include in the response.

Value: "flow_usages"
Responses
200

OK

401

Authorization information is missing or invalid.

get/destinations
Request samples 
Response samples 
application/json
[
  • {
    • "name": "Salesforce",
    • "integration_name": "string",
    • "integration_icon_url": "string",
    • "instance_id": "string",
    • "actions": [
      • {
        • "name": "Add Lead",
        • "action_id": "Add Lead",
        • "webhook_url": "string"
        }
      ],
    • "flow_usages": {
      • "count": 0,
      • "flows": [
        • {
          • "id": "5fd4371e940df5a34a3888b2",
          • "name": "string"
          }
        ]
      }
    }
]
List all flows
Returns all the flows associated to an account


SecurityAPIKey 
Responses 
200
OK


401
Authorization information is missing or invalid.


get/flows
Request samples 
Response samples 
application/json
[
  • {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "Sales Leads",
    • "errors": { },
    • "enabled": true,
    • "fields": [
      • "first_name",
      • "last_name",
      • "email",
      • "phone_1",
      • "address_1",
      • "city",
      • "state",
      • "postal_code",
      • "trustedform_cert_url"
      ],
    • "caps": { },
    • "acceptance_criteria": {
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "outcome": "failure",
      • "reason": "string"
      },
    • "pricing": {
      • "override": true,
      • "prices": [
        • {
          • "id": { },
          • "amount": 0,
          • "rule_set": {
            • "id": "1aacd0",
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            }
          }
        ]
      },
    • "list_checks": {
      • "duplicate": {
        • "value": "string",
        • "list_name": "string",
        • "lookback": { }
        },
      • "existing_customer": {
        • "value": "string",
        • "list_name": "string",
        • "lookback": { }
        },
      • "dnc": {
        • "value": "string",
        • "list_name": "string",
        • "lookback": { }
        }
      },
    • "destinations": [
      • {
        • "name": "Salesforce",
        • "integration_name": "string",
        • "integration_icon_url": "string",
        • "instance_id": "string",
        • "actions": [
          • {
            • "name": "Add Lead",
            • "action_id": "Add Lead",
            • "webhook_url": "string"
            }
          ],
        • "flow_usages": {
          • "count": 0,
          • "flows": [
            • {
              • "id": "5fd4371e940df5a34a3888b2",
              • "name": "string"
              }
            ]
          }
        }
      ],
    • "sources": [
      • {
        • "id": "1aacd0",
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "id": "1aacd0",
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          },
        • "entity": {
          • "id": "5fd4371e940df5a34a3888b2",
          • "name": "string",
          • "time_zone": "America/New_York"
          },
        • "acceptance_criteria": {
          • "rule_set": {
            • "id": "1aacd0",
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            },
          • "outcome": "failure",
          • "reason": "string"
          },
        • "feedback": {
          • "rule_set": {
            • "id": "1aacd0",
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            },
          • "integration": {
            • "module_id": "string",
            • "mappings": [
              • {
                • "id": null,
                • "property": null,
                • "value": null,
                • "rule_set": null
                }
              ]
            }
          },
        • "caps": { },
        • "ping_limits": [
          • {
            • "id": "5fd4371e940df5a34a3888b2",
            • "name": "string",
            • "maximum": 0,
            • "duration": 0,
            • "duration_units": "string",
            • "time_zone": "America/New_York",
            • "created_at": "2019-08-24T14:15:22Z"
            }
          ],
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "pricing": {
          • "override": true,
          • "prices": [
            • {
              • "id": { },
              • "amount": 0,
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          },
        • "pricing_service": {
          • "service_id": "5fd4371e940df5a34a3888b2",
          • "fallback_price": 0
          },
        • "enabled": true,
        • "authentication_required": true
        }
      ],
    • "steps": [
      • {
        • "type": "filter",
        • "id": "1aacd0",
        • "description": "string",
        • "notes": "string",
        • "reason": "string",
        • "outcome": "string",
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "enabled": true
        }
      ],
    • "ping_enabled": false,
    • "ping_limits": [
      • {
        • "id": "5fd4371e940df5a34a3888b2",
        • "name": "string",
        • "maximum": 0,
        • "duration": 0,
        • "duration_units": "string",
        • "time_zone": "America/New_York",
        • "created_at": "2019-08-24T14:15:22Z"
        }
      ],
    • "pricing_service": {
      • "service_id": "5fd4371e940df5a34a3888b2",
      • "fallback_price": 0
      },
    • "firehose": {
      • "credential_id": "5fd4371e940df5a34a3888b2",
      • "enabled": true,
      • "bucket": "string",
      • "prefix": "string",
      • "services": {
        • "aws": {
          • "enabled": true,
          • "credential_id": "5fd4371e940df5a34a3888b2",
          • "bucket": "string",
          • "prefix": "string"
          },
        • "azure": {
          • "enabled": true,
          • "credential_id": "5fd4371e940df5a34a3888b2",
          • "bucket": "string",
          • "prefix": "string"
          }
        }
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
]
Create a new flow
Create a new flow, adding it to the list of all flows in the account. The caller may specify an ID for a flow, provided it is a valid BSON ID


SecurityAPIKey 
Request 
Request Body schema: application/json
required
Create a new flow


name
required
string  non-empty 
The name of the flow


 
enabled
required
boolean
Disabling a flow will prevent any processing of lead submissions. Submission will result in an error outcome.


 
fields
required
Array of strings
The list of fields (IDs) representing the lead to be processed by this flow.


 
null or Array of objects (Caps) 
 
object (acceptance-criteria) 
A submitted lead that fails an acceptance criteria rule will be rejected. Lead submission will result in a failure outcome.


 
object (Pricing) 
This pricing configuration applies to all leads submitted to this flow. Pricing determines the value of 
the purchase_price and cost property on the source event recorded when a lead is submitted. 


Each price is evaluated and the last price for which all rules match will determine the amount used
for the purchase_price and cost. If none of these prices match for a particular lead, source pricing
will be evaluated. If no price matches, the price properties on the source event will be set to 0.


 
object (ListChecks) 
Check the lead against SuppressionList lists to see if it's a duplicate, and existing customer, or is on the
do-not-call list.


 
Array of objects (Destination) 
 
required
Array of objects (Source) 
 
required
Array of Filter Step (object) or Recipient Step (object)
 
ping_enabled
boolean
 Default:  false
 
Array of objects (PingLimits) 
 
object (PricingServiceConfiguration) 
The configuration required on a Source or Flow to define a Pricing Service for lead pricing.


 
object (Firehose) 
 
Responses 
201
Created


post/flows
Request samples 
application/json
{
  • "name": "Sales Leads",
  • "enabled": true,
  • "fields": [
    • "first_name",
    • "last_name",
    • "email",
    • "phone_1",
    • "address_1",
    • "city",
    • "state",
    • "postal_code",
    • "trustedform_cert_url"
    ],
  • "caps": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "op": "and",
      • "rules": [
        • {
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "pricing": {
    • "override": true,
    • "prices": [
      • {
        • "id": { },
        • "amount": 0,
        • "rule_set": {
          • "op": "and",
          • "rules": [
            • {
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ]
    },
  • "list_checks": {
    • "duplicate": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "existing_customer": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "dnc": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      }
    },
  • "destinations": [
    • {
      • "name": "Salesforce",
      • "integration_name": "string",
      • "integration_icon_url": "string",
      • "instance_id": "string",
      • "actions": [
        • {
          • "name": "Add Lead",
          • "action_id": "Add Lead",
          • "webhook_url": "string"
          }
        ],
      • "flow_usages": {
        • "count": 0,
        • "flows": [
          • {
            • "name": "string"
            }
          ]
        }
      }
    ],
  • "sources": [
    • {
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "time_zone": "America/New_York"
        },
      • "acceptance_criteria": {
        • "rule_set": {
          • "op": "and",
          • "rules": [
            • {
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "outcome": "failure",
        • "reason": "string"
        },
      • "feedback": {
        • "rule_set": {
          • "op": "and",
          • "rules": [
            • {
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          }
        },
      • "caps": { },
      • "ping_limits": [
        • {
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "pricing_service": {
        • "fallback_price": 0
        },
      • "enabled": true,
      • "authentication_required": true
      }
    ],
  • "steps": [
    • {
      • "type": "filter",
      • "description": "string",
      • "notes": "string",
      • "reason": "string",
      • "outcome": "string",
      • "rule_set": {
        • "op": "and",
        • "rules": [
          • {
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "enabled": true
      }
    ],
  • "ping_enabled": false,
  • "ping_limits": [
    • {
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "pricing_service": {
    • "fallback_price": 0
    },
  • "firehose": {
    • "enabled": true,
    • "bucket": "string",
    • "prefix": "string",
    • "services": {
      • "aws": {
        • "enabled": true,
        • "bucket": "string",
        • "prefix": "string"
        },
      • "azure": {
        • "enabled": true,
        • "bucket": "string",
        • "prefix": "string"
        }
      }
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "Sales Leads",
  • "errors": { },
  • "enabled": true,
  • "fields": [
    • "first_name",
    • "last_name",
    • "email",
    • "phone_1",
    • "address_1",
    • "city",
    • "state",
    • "postal_code",
    • "trustedform_cert_url"
    ],
  • "caps": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "id": "1aacd0",
      • "op": "and",
      • "rules": [
        • {
          • "id": "1aacd0",
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "pricing": {
    • "override": true,
    • "prices": [
      • {
        • "id": { },
        • "amount": 0,
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ]
    },
  • "list_checks": {
    • "duplicate": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "existing_customer": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "dnc": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      }
    },
  • "destinations": [
    • {
      • "name": "Salesforce",
      • "integration_name": "string",
      • "integration_icon_url": "string",
      • "instance_id": "string",
      • "actions": [
        • {
          • "name": "Add Lead",
          • "action_id": "Add Lead",
          • "webhook_url": "string"
          }
        ],
      • "flow_usages": {
        • "count": 0,
        • "flows": [
          • {
            • "id": "5fd4371e940df5a34a3888b2",
            • "name": "string"
            }
          ]
        }
      }
    ],
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "5fd4371e940df5a34a3888b2",
        • "name": "string",
        • "time_zone": "America/New_York"
        },
      • "acceptance_criteria": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "outcome": "failure",
        • "reason": "string"
        },
      • "feedback": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "id": "1aacd0",
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          }
        },
      • "caps": { },
      • "ping_limits": [
        • {
          • "id": "5fd4371e940df5a34a3888b2",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "credential_id": "5fd4371e940df5a34a3888b2",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "pricing_service": {
        • "service_id": "5fd4371e940df5a34a3888b2",
        • "fallback_price": 0
        },
      • "enabled": true,
      • "authentication_required": true
      }
    ],
  • "steps": [
    • {
      • "type": "filter",
      • "id": "1aacd0",
      • "description": "string",
      • "notes": "string",
      • "reason": "string",
      • "outcome": "string",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "enabled": true
      }
    ],
  • "ping_enabled": false,
  • "ping_limits": [
    • {
      • "id": "5fd4371e940df5a34a3888b2",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "pricing_service": {
    • "service_id": "5fd4371e940df5a34a3888b2",
    • "fallback_price": 0
    },
  • "firehose": {
    • "credential_id": "5fd4371e940df5a34a3888b2",
    • "enabled": true,
    • "bucket": "string",
    • "prefix": "string",
    • "services": {
      • "aws": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        },
      • "azure": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        }
      }
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Update all flows
Update all flows for an account. Only users with superuser access can run this.


SecurityAPIKey 
Responses 
200
OK


put/flows
Request samples 
Get a flow
Returns the flow associated to the ID


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the flow to get


 
 Example:  5fd4371e940df5a34a3888b2
Responses 
200
OK


get/flows/{id}
Request samples 
Response samples 
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "Sales Leads",
  • "errors": { },
  • "enabled": true,
  • "fields": [
    • "first_name",
    • "last_name",
    • "email",
    • "phone_1",
    • "address_1",
    • "city",
    • "state",
    • "postal_code",
    • "trustedform_cert_url"
    ],
  • "caps": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "id": "1aacd0",
      • "op": "and",
      • "rules": [
        • {
          • "id": "1aacd0",
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "pricing": {
    • "override": true,
    • "prices": [
      • {
        • "id": { },
        • "amount": 0,
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ]
    },
  • "list_checks": {
    • "duplicate": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "existing_customer": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "dnc": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      }
    },
  • "destinations": [
    • {
      • "name": "Salesforce",
      • "integration_name": "string",
      • "integration_icon_url": "string",
      • "instance_id": "string",
      • "actions": [
        • {
          • "name": "Add Lead",
          • "action_id": "Add Lead",
          • "webhook_url": "string"
          }
        ],
      • "flow_usages": {
        • "count": 0,
        • "flows": [
          • {
            • "id": "5fd4371e940df5a34a3888b2",
            • "name": "string"
            }
          ]
        }
      }
    ],
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "5fd4371e940df5a34a3888b2",
        • "name": "string",
        • "time_zone": "America/New_York"
        },
      • "acceptance_criteria": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "outcome": "failure",
        • "reason": "string"
        },
      • "feedback": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "id": "1aacd0",
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          }
        },
      • "caps": { },
      • "ping_limits": [
        • {
          • "id": "5fd4371e940df5a34a3888b2",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "credential_id": "5fd4371e940df5a34a3888b2",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "pricing_service": {
        • "service_id": "5fd4371e940df5a34a3888b2",
        • "fallback_price": 0
        },
      • "enabled": true,
      • "authentication_required": true
      }
    ],
  • "steps": [
    • {
      • "type": "filter",
      • "id": "1aacd0",
      • "description": "string",
      • "notes": "string",
      • "reason": "string",
      • "outcome": "string",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "enabled": true
      }
    ],
  • "ping_enabled": false,
  • "ping_limits": [
    • {
      • "id": "5fd4371e940df5a34a3888b2",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "pricing_service": {
    • "service_id": "5fd4371e940df5a34a3888b2",
    • "fallback_price": 0
    },
  • "firehose": {
    • "credential_id": "5fd4371e940df5a34a3888b2",
    • "enabled": true,
    • "bucket": "string",
    • "prefix": "string",
    • "services": {
      • "aws": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        },
      • "azure": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        }
      }
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Update an existing flow
Update an existing Flow


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the flow to update


 
 Example:  5fd4371e940df5a34a3888b2
Request Body schema: application/json
required
Update a flow


name
required
string  non-empty 
The name of the flow


 
enabled
required
boolean
Disabling a flow will prevent any processing of lead submissions. Submission will result in an error outcome.


 
fields
required
Array of strings
The list of fields (IDs) representing the lead to be processed by this flow.


 
null or Array of objects (Caps) 
 
object (acceptance-criteria) 
A submitted lead that fails an acceptance criteria rule will be rejected. Lead submission will result in a failure outcome.


 
object (Pricing) 
This pricing configuration applies to all leads submitted to this flow. Pricing determines the value of 
the purchase_price and cost property on the source event recorded when a lead is submitted. 


Each price is evaluated and the last price for which all rules match will determine the amount used
for the purchase_price and cost. If none of these prices match for a particular lead, source pricing
will be evaluated. If no price matches, the price properties on the source event will be set to 0.


 
object (ListChecks) 
Check the lead against SuppressionList lists to see if it's a duplicate, and existing customer, or is on the
do-not-call list.


 
Array of objects (Destination) 
 
required
Array of objects (Source) 
 
required
Array of Filter Step (object) or Recipient Step (object)
 
ping_enabled
boolean
 Default:  false
 
Array of objects (PingLimits) 
 
object (PricingServiceConfiguration) 
The configuration required on a Source or Flow to define a Pricing Service for lead pricing.


 
object (Firehose) 
 
Responses 
200
OK


put/flows/{id}
Request samples 
application/json
{
  • "name": "Sales Leads",
  • "enabled": true,
  • "fields": [
    • "first_name",
    • "last_name",
    • "email",
    • "phone_1",
    • "address_1",
    • "city",
    • "state",
    • "postal_code",
    • "trustedform_cert_url"
    ],
  • "caps": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "op": "and",
      • "rules": [
        • {
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "pricing": {
    • "override": true,
    • "prices": [
      • {
        • "id": { },
        • "amount": 0,
        • "rule_set": {
          • "op": "and",
          • "rules": [
            • {
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ]
    },
  • "list_checks": {
    • "duplicate": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "existing_customer": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "dnc": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      }
    },
  • "destinations": [
    • {
      • "name": "Salesforce",
      • "integration_name": "string",
      • "integration_icon_url": "string",
      • "instance_id": "string",
      • "actions": [
        • {
          • "name": "Add Lead",
          • "action_id": "Add Lead",
          • "webhook_url": "string"
          }
        ],
      • "flow_usages": {
        • "count": 0,
        • "flows": [
          • {
            • "name": "string"
            }
          ]
        }
      }
    ],
  • "sources": [
    • {
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "time_zone": "America/New_York"
        },
      • "acceptance_criteria": {
        • "rule_set": {
          • "op": "and",
          • "rules": [
            • {
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "outcome": "failure",
        • "reason": "string"
        },
      • "feedback": {
        • "rule_set": {
          • "op": "and",
          • "rules": [
            • {
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          }
        },
      • "caps": { },
      • "ping_limits": [
        • {
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "pricing_service": {
        • "fallback_price": 0
        },
      • "enabled": true,
      • "authentication_required": true
      }
    ],
  • "steps": [
    • {
      • "type": "filter",
      • "description": "string",
      • "notes": "string",
      • "reason": "string",
      • "outcome": "string",
      • "rule_set": {
        • "op": "and",
        • "rules": [
          • {
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "enabled": true
      }
    ],
  • "ping_enabled": false,
  • "ping_limits": [
    • {
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "pricing_service": {
    • "fallback_price": 0
    },
  • "firehose": {
    • "enabled": true,
    • "bucket": "string",
    • "prefix": "string",
    • "services": {
      • "aws": {
        • "enabled": true,
        • "bucket": "string",
        • "prefix": "string"
        },
      • "azure": {
        • "enabled": true,
        • "bucket": "string",
        • "prefix": "string"
        }
      }
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "Sales Leads",
  • "errors": { },
  • "enabled": true,
  • "fields": [
    • "first_name",
    • "last_name",
    • "email",
    • "phone_1",
    • "address_1",
    • "city",
    • "state",
    • "postal_code",
    • "trustedform_cert_url"
    ],
  • "caps": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "id": "1aacd0",
      • "op": "and",
      • "rules": [
        • {
          • "id": "1aacd0",
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "pricing": {
    • "override": true,
    • "prices": [
      • {
        • "id": { },
        • "amount": 0,
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ]
    },
  • "list_checks": {
    • "duplicate": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "existing_customer": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "dnc": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      }
    },
  • "destinations": [
    • {
      • "name": "Salesforce",
      • "integration_name": "string",
      • "integration_icon_url": "string",
      • "instance_id": "string",
      • "actions": [
        • {
          • "name": "Add Lead",
          • "action_id": "Add Lead",
          • "webhook_url": "string"
          }
        ],
      • "flow_usages": {
        • "count": 0,
        • "flows": [
          • {
            • "id": "5fd4371e940df5a34a3888b2",
            • "name": "string"
            }
          ]
        }
      }
    ],
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "5fd4371e940df5a34a3888b2",
        • "name": "string",
        • "time_zone": "America/New_York"
        },
      • "acceptance_criteria": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "outcome": "failure",
        • "reason": "string"
        },
      • "feedback": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "id": "1aacd0",
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          }
        },
      • "caps": { },
      • "ping_limits": [
        • {
          • "id": "5fd4371e940df5a34a3888b2",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "credential_id": "5fd4371e940df5a34a3888b2",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "pricing_service": {
        • "service_id": "5fd4371e940df5a34a3888b2",
        • "fallback_price": 0
        },
      • "enabled": true,
      • "authentication_required": true
      }
    ],
  • "steps": [
    • {
      • "type": "filter",
      • "id": "1aacd0",
      • "description": "string",
      • "notes": "string",
      • "reason": "string",
      • "outcome": "string",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "enabled": true
      }
    ],
  • "ping_enabled": false,
  • "ping_limits": [
    • {
      • "id": "5fd4371e940df5a34a3888b2",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "pricing_service": {
    • "service_id": "5fd4371e940df5a34a3888b2",
    • "fallback_price": 0
    },
  • "firehose": {
    • "credential_id": "5fd4371e940df5a34a3888b2",
    • "enabled": true,
    • "bucket": "string",
    • "prefix": "string",
    • "services": {
      • "aws": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        },
      • "azure": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        }
      }
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Delete an existing flow
Once a flow is deleted it will no longer accept leads. Attempting to submit leads to a deleted flow will result in an HTTP 404. Returns the flow as it existed at the time of deletion.


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the flow to delete


 
 Example:  5fd4371e940df5a34a3888b2
Responses 
200
OK


delete/flows/{id}
Request samples 
Response samples 
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "Sales Leads",
  • "errors": { },
  • "enabled": true,
  • "fields": [
    • "first_name",
    • "last_name",
    • "email",
    • "phone_1",
    • "address_1",
    • "city",
    • "state",
    • "postal_code",
    • "trustedform_cert_url"
    ],
  • "caps": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "id": "1aacd0",
      • "op": "and",
      • "rules": [
        • {
          • "id": "1aacd0",
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "pricing": {
    • "override": true,
    • "prices": [
      • {
        • "id": { },
        • "amount": 0,
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ]
    },
  • "list_checks": {
    • "duplicate": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "existing_customer": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      },
    • "dnc": {
      • "value": "string",
      • "list_name": "string",
      • "lookback": { }
      }
    },
  • "destinations": [
    • {
      • "name": "Salesforce",
      • "integration_name": "string",
      • "integration_icon_url": "string",
      • "instance_id": "string",
      • "actions": [
        • {
          • "name": "Add Lead",
          • "action_id": "Add Lead",
          • "webhook_url": "string"
          }
        ],
      • "flow_usages": {
        • "count": 0,
        • "flows": [
          • {
            • "id": "5fd4371e940df5a34a3888b2",
            • "name": "string"
            }
          ]
        }
      }
    ],
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "5fd4371e940df5a34a3888b2",
        • "name": "string",
        • "time_zone": "America/New_York"
        },
      • "acceptance_criteria": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "outcome": "failure",
        • "reason": "string"
        },
      • "feedback": {
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "id": "1aacd0",
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          }
        },
      • "caps": { },
      • "ping_limits": [
        • {
          • "id": "5fd4371e940df5a34a3888b2",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "credential_id": "5fd4371e940df5a34a3888b2",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "pricing_service": {
        • "service_id": "5fd4371e940df5a34a3888b2",
        • "fallback_price": 0
        },
      • "enabled": true,
      • "authentication_required": true
      }
    ],
  • "steps": [
    • {
      • "type": "filter",
      • "id": "1aacd0",
      • "description": "string",
      • "notes": "string",
      • "reason": "string",
      • "outcome": "string",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "enabled": true
      }
    ],
  • "ping_enabled": false,
  • "ping_limits": [
    • {
      • "id": "5fd4371e940df5a34a3888b2",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "pricing_service": {
    • "service_id": "5fd4371e940df5a34a3888b2",
    • "fallback_price": 0
    },
  • "firehose": {
    • "credential_id": "5fd4371e940df5a34a3888b2",
    • "enabled": true,
    • "bucket": "string",
    • "prefix": "string",
    • "services": {
      • "aws": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        },
      • "azure": {
        • "enabled": true,
        • "credential_id": "5fd4371e940df5a34a3888b2",
        • "bucket": "string",
        • "prefix": "string"
        }
      }
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Deploy a saved flow to production
A flow defines how lead submissions will be handled. In order to make a flow's latest state active for lead handling, it must be deployed. Because changes to a flow can be made without deploying them, you are free make flow updates without affecting current lead handling.  Put another way, a deployment must be performed after it is created or updated in order for lead handling to start using the new configuration.


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the flow to deploy


 
 Example:  5fd4371e940df5a34a3888b2
Responses 
200
OK


post/flows/{id}/deploy
Request samples 
Response samples 
application/json
{
  • "message": "Your flow was deployed and the most recent changes are now live"
}
List fields associated to the Flow
List fields associated to the Flow


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the flow schema


 
 Example:  5fd4371e940df5a34a3888b2
Responses 
200
OK


get/flows/{id}/fields
Request samples 
Response samples 
application/json
[
  • {
    • "id": "first_name",
    • "name": "First Name",
    • "type": "boolean",
    • "description": "string",
    • "standard": true,
    • "aggregate": true,
    • "deprecated": true,
    • "see": "5fd4371e940df5a34a3888b2",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
]
Get flow field usages
Count the number of leads processed by flow field. This tells you which and how much each flow field was used today. You can change the timeframe using the timeframe parameter (i.e. timeframe=previous_30_days), though this is discouraged because this query is fairly heavy.


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the flow


 
 Example:  5fd4371e940df5a34a3888b2
query Parameters
timeframe
string
 
Responses 
200
OK


get/flows/{id}/fields/usage
Request samples 
Response samples 
application/json
{
  • "property1": 0,
  • "property2": 0
}
Retrieve metadata for a specific source within a flow
Returns metadata about a source within a specified flow, including parameters, account details, and operational settings.


SecurityAPIKey 
Request 
path Parameters
flow_id
required
string
The ID of the flow


 
 Example:  67dc2ec447ba19de15745945
source_id
required
string
The ID of the source within the flow


 
 Example:  53a310fa9d29c9c72100006c
Responses 
200
Successful response with source metadata


400
Bad request due to invalid flow_id or source_id


404
Flow or source not found


get/flows/{flow_id}/sources/{source_id}/meta
Request samples 
Response samples 
application/json
{
  • "enabled": true,
  • "account": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "ActiveProspect, Inc."
    },
  • "flow": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "string"
    },
  • "source": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "string",
    • "authentication_required": false
    },
  • "hours_of_operation": { },
  • "acceptance_criteria": {
    • "rule_set": {
      • "id": "1aacd0",
      • "op": "and",
      • "rules": [
        • {
          • "id": "1aacd0",
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "string"
    },
  • "flow_acceptance_criteria": { },
  • "params": [
    • {
      • "name": "first_name",
      • "label": "First Name",
      • "description": "First name",
      • "type": "first_name",
      • "variable": "first_name",
      • "examples": [
        • "Mike",
        • "Robert",
        • "Janet"
        ],
      • "required": "no"
      }
    ],
  • "flow_pricing": null,
  • "source_pricing": null,
  • "pingable": true,
  • "ping_enabled": false,
  • "updated_at": "2025-03-20T15:06:01.777Z",
  • "authorized_account": true
}
Submit data to a source within a flow
Submits JSON lead data to a specified source within a flow and returning a success response in JSON.


SecurityAPIKey 
Request 
path Parameters
flow_id
required
string (ID) ^[0-9a-fA-F]{24}$
The ID of the flow


 
 Example:  5fd4371e940df5a34a3888b2
source_id
required
string (ID) ^[0-9a-fA-F]{24}$
The ID of the source within the flow


 
 Example:  5fd4371e940df5a34a3888b2
Request Body schema: application/json
required
The JSON lead data to submit.


property name*
additional property
string
A dynamic set of key-value pairs representing lead data.


 
Responses 
200
A list of metadata records for lead submissions.


400
Bad request due to invalid flow_id or source_id


404
Flow or source not found


post/flows/{flow_id}/sources/{source_id}/submit
Request samples 
application/json
{
  • "email": "user@example.com",
  • "fname": "Example User"
}
Response samples 
application/json
[
  • {
    • "request": {},
    • "response": {
      • "status": 201,
      • "headers": {
        • "Content-Type": "application/json",
        • "Content-Length": "72"
        },
      • "body": "{\"outcome\":\"success\",\"lead\":{\"id\":\"abc123\"},\"price\":0}"
      }
    }
]