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 phonenumber 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

Flow

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

24 character alpha-numeric BSON identifier

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.

Array of objects or null non-empty

Caps on leads submitted into this flow from any source. These caps will be processed before caps set on a source.

object or null (Acceptance Criteria)

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

object

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.

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
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": [
    • {
      • "id": "string",
      • "type": "volume",
      • "name": "Monthly leads from TX",
      • "maximum": 1200,
      • "duration": 1,
      • "duration_units": "month",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "caps": [
        • { }
        ],
      • "time_zone": "America/New_York",
      • "reason": "string",
      • "created_at": "2020-11-23T11:41:52Z"
      }
    ],
  • "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": "Lead must live in TX"
    },
  • "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": "{{lead.phone}}",
      • "list_name": "duplicates",
      • "lookback": {
        • "value": 7,
        • "interval": "day"
        }
      },
    • "existing_customer": {
      • "value": "{{lead.email}}",
      • "list_name": "customer_emails",
      • "lookback": null
      },
    • "dnc": {
      • "value": "{{lead.phone}}",
      • "list_name": "do_not_call",
      • "lookback": null
      }
    },
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "string",
        • "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": "Lead must live in TX"
        },
      • "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": [
        • {
          • "id": "string",
          • "type": "volume",
          • "name": "Monthly leads from TX",
          • "maximum": 1200,
          • "duration": 1,
          • "duration_units": "month",
          • "rule_set": {
            • "id": "1aacd0",
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            },
          • "caps": [
            • { }
            ],
          • "time_zone": "America/New_York",
          • "reason": "string",
          • "created_at": "2020-11-23T11:41:52Z"
          }
        ],
      • "ping_limits": [
        • {
          • "id": "6402715c40926f93753580d9",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "string"
          }
        ],
      • "credential_id": "5fd43a1e627715453aaafff1",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "enabled": 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": "6402715c40926f93753580d9",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "string"
      }
    ],
  • "firehose": {
    • "credential_id": "5fd43a1e627715453aaafff1",
    • "bucket": "string",
    • "prefix": "string",
    • "enabled": true
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

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": [
      • {
        • "id": "string",
        • "type": "volume",
        • "name": "Monthly leads from TX",
        • "maximum": 1200,
        • "duration": 1,
        • "duration_units": "month",
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          },
        • "caps": [
          • { }
          ],
        • "time_zone": "America/New_York",
        • "reason": "string",
        • "created_at": "2020-11-23T11:41:52Z"
        }
      ],
    • "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": "Lead must live in TX"
      },
    • "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": "{{lead.phone}}",
        • "list_name": "duplicates",
        • "lookback": {
          • "value": 7,
          • "interval": "day"
          }
        },
      • "existing_customer": {
        • "value": "{{lead.email}}",
        • "list_name": "customer_emails",
        • "lookback": null
        },
      • "dnc": {
        • "value": "{{lead.phone}}",
        • "list_name": "do_not_call",
        • "lookback": null
        }
      },
    • "sources": [
      • {
        • "id": "1aacd0",
        • "integration": {
          • "module_id": "string",
          • "mappings": [
            • {
              • "id": "1aacd0",
              • "property": "string",
              • "value": "string",
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          },
        • "entity": {
          • "id": "string",
          • "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": "Lead must live in TX"
          },
        • "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": [
          • {
            • "id": "string",
            • "type": "volume",
            • "name": "Monthly leads from TX",
            • "maximum": 1200,
            • "duration": 1,
            • "duration_units": "month",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              },
            • "caps": [
              • { }
              ],
            • "time_zone": "America/New_York",
            • "reason": "string",
            • "created_at": "2020-11-23T11:41:52Z"
            }
          ],
        • "ping_limits": [
          • {
            • "id": "6402715c40926f93753580d9",
            • "name": "string",
            • "maximum": 0,
            • "duration": 0,
            • "duration_units": "string",
            • "time_zone": "America/New_York",
            • "created_at": "string"
            }
          ],
        • "credential_id": "5fd43a1e627715453aaafff1",
        • "pricing": {
          • "override": true,
          • "prices": [
            • {
              • "id": { },
              • "amount": 0,
              • "rule_set": {
                • "id": null,
                • "op": null,
                • "rules": [ ]
                }
              }
            ]
          },
        • "enabled": 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": "6402715c40926f93753580d9",
        • "name": "string",
        • "maximum": 0,
        • "duration": 0,
        • "duration_units": "string",
        • "time_zone": "America/New_York",
        • "created_at": "string"
        }
      ],
    • "firehose": {
      • "credential_id": "5fd43a1e627715453aaafff1",
      • "bucket": "string",
      • "prefix": "string",
      • "enabled": true
      },
    • "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
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.


 
Array of objects or null  non-empty 
Caps on leads submitted into this flow from any source. These caps will be processed before caps set on a source.


 
object or null (Acceptance Criteria) 
A submitted lead that fails an acceptance criteria rule will be rejected. Lead submission will result in a failure outcome.


 
object
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.


 
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
 
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": [
    • {
      • "type": "volume",
      • "name": "Monthly leads from TX",
      • "maximum": 1200,
      • "duration": 1,
      • "duration_units": "month",
      • "rule_set": {
        • "op": "and",
        • "rules": [
          • {
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "caps": [
        • { }
        ],
      • "time_zone": "America/New_York",
      • "reason": "string",
      • "created_at": "2020-11-23T11:41:52Z"
      }
    ],
  • "acceptance_criteria": {
    • "rule_set": {
      • "op": "and",
      • "rules": [
        • {
          • "lhv": "lead.state",
          • "op": "is equal to",
          • "rhv": "TX",
          • "rule_set": { }
          }
        ]
      },
    • "outcome": "failure",
    • "reason": "Lead must live in TX"
    },
  • "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": "{{lead.phone}}",
      • "list_name": "duplicates",
      • "lookback": {
        • "value": 7,
        • "interval": "day"
        }
      },
    • "existing_customer": {
      • "value": "{{lead.email}}",
      • "list_name": "customer_emails",
      • "lookback": null
      },
    • "dnc": {
      • "value": "{{lead.phone}}",
      • "list_name": "do_not_call",
      • "lookback": null
      }
    },
  • "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": "Lead must live in TX"
        },
      • "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": [
        • {
          • "type": "volume",
          • "name": "Monthly leads from TX",
          • "maximum": 1200,
          • "duration": 1,
          • "duration_units": "month",
          • "rule_set": {
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            },
          • "caps": [
            • { }
            ],
          • "time_zone": "America/New_York",
          • "reason": "string",
          • "created_at": "2020-11-23T11:41:52Z"
          }
        ],
      • "ping_limits": [
        • {
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York"
          }
        ],
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "enabled": 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"
      }
    ],
  • "firehose": {
    • "bucket": "string",
    • "prefix": "string",
    • "enabled": true
    },
  • "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": [
    • {
      • "id": "string",
      • "type": "volume",
      • "name": "Monthly leads from TX",
      • "maximum": 1200,
      • "duration": 1,
      • "duration_units": "month",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "caps": [
        • { }
        ],
      • "time_zone": "America/New_York",
      • "reason": "string",
      • "created_at": "2020-11-23T11:41:52Z"
      }
    ],
  • "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": "Lead must live in TX"
    },
  • "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": "{{lead.phone}}",
      • "list_name": "duplicates",
      • "lookback": {
        • "value": 7,
        • "interval": "day"
        }
      },
    • "existing_customer": {
      • "value": "{{lead.email}}",
      • "list_name": "customer_emails",
      • "lookback": null
      },
    • "dnc": {
      • "value": "{{lead.phone}}",
      • "list_name": "do_not_call",
      • "lookback": null
      }
    },
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "string",
        • "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": "Lead must live in TX"
        },
      • "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": [
        • {
          • "id": "string",
          • "type": "volume",
          • "name": "Monthly leads from TX",
          • "maximum": 1200,
          • "duration": 1,
          • "duration_units": "month",
          • "rule_set": {
            • "id": "1aacd0",
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            },
          • "caps": [
            • { }
            ],
          • "time_zone": "America/New_York",
          • "reason": "string",
          • "created_at": "2020-11-23T11:41:52Z"
          }
        ],
      • "ping_limits": [
        • {
          • "id": "6402715c40926f93753580d9",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "string"
          }
        ],
      • "credential_id": "5fd43a1e627715453aaafff1",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "enabled": 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": "6402715c40926f93753580d9",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "string"
      }
    ],
  • "firehose": {
    • "credential_id": "5fd43a1e627715453aaafff1",
    • "bucket": "string",
    • "prefix": "string",
    • "enabled": true
    },
  • "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


 
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": [
    • {
      • "id": "string",
      • "type": "volume",
      • "name": "Monthly leads from TX",
      • "maximum": 1200,
      • "duration": 1,
      • "duration_units": "month",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "caps": [
        • { }
        ],
      • "time_zone": "America/New_York",
      • "reason": "string",
      • "created_at": "2020-11-23T11:41:52Z"
      }
    ],
  • "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": "Lead must live in TX"
    },
  • "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": "{{lead.phone}}",
      • "list_name": "duplicates",
      • "lookback": {
        • "value": 7,
        • "interval": "day"
        }
      },
    • "existing_customer": {
      • "value": "{{lead.email}}",
      • "list_name": "customer_emails",
      • "lookback": null
      },
    • "dnc": {
      • "value": "{{lead.phone}}",
      • "list_name": "do_not_call",
      • "lookback": null
      }
    },
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "string",
        • "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": "Lead must live in TX"
        },
      • "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": [
        • {
          • "id": "string",
          • "type": "volume",
          • "name": "Monthly leads from TX",
          • "maximum": 1200,
          • "duration": 1,
          • "duration_units": "month",
          • "rule_set": {
            • "id": "1aacd0",
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            },
          • "caps": [
            • { }
            ],
          • "time_zone": "America/New_York",
          • "reason": "string",
          • "created_at": "2020-11-23T11:41:52Z"
          }
        ],
      • "ping_limits": [
        • {
          • "id": "6402715c40926f93753580d9",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "string"
          }
        ],
      • "credential_id": "5fd43a1e627715453aaafff1",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "enabled": 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": "6402715c40926f93753580d9",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "string"
      }
    ],
  • "firehose": {
    • "credential_id": "5fd43a1e627715453aaafff1",
    • "bucket": "string",
    • "prefix": "string",
    • "enabled": true
    },
  • "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


 
Responses 
200
OK


put/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": [
    • {
      • "id": "string",
      • "type": "volume",
      • "name": "Monthly leads from TX",
      • "maximum": 1200,
      • "duration": 1,
      • "duration_units": "month",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "caps": [
        • { }
        ],
      • "time_zone": "America/New_York",
      • "reason": "string",
      • "created_at": "2020-11-23T11:41:52Z"
      }
    ],
  • "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": "Lead must live in TX"
    },
  • "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": "{{lead.phone}}",
      • "list_name": "duplicates",
      • "lookback": {
        • "value": 7,
        • "interval": "day"
        }
      },
    • "existing_customer": {
      • "value": "{{lead.email}}",
      • "list_name": "customer_emails",
      • "lookback": null
      },
    • "dnc": {
      • "value": "{{lead.phone}}",
      • "list_name": "do_not_call",
      • "lookback": null
      }
    },
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "string",
        • "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": "Lead must live in TX"
        },
      • "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": [
        • {
          • "id": "string",
          • "type": "volume",
          • "name": "Monthly leads from TX",
          • "maximum": 1200,
          • "duration": 1,
          • "duration_units": "month",
          • "rule_set": {
            • "id": "1aacd0",
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            },
          • "caps": [
            • { }
            ],
          • "time_zone": "America/New_York",
          • "reason": "string",
          • "created_at": "2020-11-23T11:41:52Z"
          }
        ],
      • "ping_limits": [
        • {
          • "id": "6402715c40926f93753580d9",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "string"
          }
        ],
      • "credential_id": "5fd43a1e627715453aaafff1",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "enabled": 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": "6402715c40926f93753580d9",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "string"
      }
    ],
  • "firehose": {
    • "credential_id": "5fd43a1e627715453aaafff1",
    • "bucket": "string",
    • "prefix": "string",
    • "enabled": true
    },
  • "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


 
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": [
    • {
      • "id": "string",
      • "type": "volume",
      • "name": "Monthly leads from TX",
      • "maximum": 1200,
      • "duration": 1,
      • "duration_units": "month",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        },
      • "caps": [
        • { }
        ],
      • "time_zone": "America/New_York",
      • "reason": "string",
      • "created_at": "2020-11-23T11:41:52Z"
      }
    ],
  • "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": "Lead must live in TX"
    },
  • "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": "{{lead.phone}}",
      • "list_name": "duplicates",
      • "lookback": {
        • "value": 7,
        • "interval": "day"
        }
      },
    • "existing_customer": {
      • "value": "{{lead.email}}",
      • "list_name": "customer_emails",
      • "lookback": null
      },
    • "dnc": {
      • "value": "{{lead.phone}}",
      • "list_name": "do_not_call",
      • "lookback": null
      }
    },
  • "sources": [
    • {
      • "id": "1aacd0",
      • "integration": {
        • "module_id": "string",
        • "mappings": [
          • {
            • "id": "1aacd0",
            • "property": "string",
            • "value": "string",
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "entity": {
        • "id": "string",
        • "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": "Lead must live in TX"
        },
      • "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": [
        • {
          • "id": "string",
          • "type": "volume",
          • "name": "Monthly leads from TX",
          • "maximum": 1200,
          • "duration": 1,
          • "duration_units": "month",
          • "rule_set": {
            • "id": "1aacd0",
            • "op": "and",
            • "rules": [
              • {
                • "id": null,
                • "lhv": null,
                • "op": null,
                • "rhv": null,
                • "rule_set": null
                }
              ]
            },
          • "caps": [
            • { }
            ],
          • "time_zone": "America/New_York",
          • "reason": "string",
          • "created_at": "2020-11-23T11:41:52Z"
          }
        ],
      • "ping_limits": [
        • {
          • "id": "6402715c40926f93753580d9",
          • "name": "string",
          • "maximum": 0,
          • "duration": 0,
          • "duration_units": "string",
          • "time_zone": "America/New_York",
          • "created_at": "string"
          }
        ],
      • "credential_id": "5fd43a1e627715453aaafff1",
      • "pricing": {
        • "override": true,
        • "prices": [
          • {
            • "id": { },
            • "amount": 0,
            • "rule_set": {
              • "id": "1aacd0",
              • "op": "and",
              • "rules": [
                • null
                ]
              }
            }
          ]
        },
      • "enabled": 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": "6402715c40926f93753580d9",
      • "name": "string",
      • "maximum": 0,
      • "duration": 0,
      • "duration_units": "string",
      • "time_zone": "America/New_York",
      • "created_at": "string"
      }
    ],
  • "firehose": {
    • "credential_id": "5fd43a1e627715453aaafff1",
    • "bucket": "string",
    • "prefix": "string",
    • "enabled": true
    },
  • "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


 
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


 
Responses 
200
OK


get/flows/{id}/fields
Request samples 
Response samples 
application/json
[
  • {
    • "id": "first_name",
    • "type": "boolean",
    • "description": "string",
    • "standard": true,
    • "deprecated": true,
    • "see": "string",
    • "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


 
query Parameters
timeframe
string
 
Responses 
200
OK


get/flows/{id}/fields/usage
Request samples 
Response samples 
application/json
{
  • "property1": 0,
  • "property2": 0
}