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
An internal representation of a Prismatic instance.
name | string A human-readable name of the destination. |
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 |
{- "name": "Salesforce",
- "instance_id": "string",
- "actions": [
- {
- "name": "Add Lead",
- "action_id": "Add Lead",
- "webhook_url": "string"
}
], - "flow_usages": {
- "count": 0,
- "flows": [
- {
- "id": "5fd4371e940df5a34a3888b2",
- "name": "string"
}
]
}
}
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. |
Array of objects or null (Caps) 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 (Pricing) This pricing configuration applies to all leads submitted to this flow. Pricing determines the value of
the Each price is evaluated and the last price for which all rules match will determine the amount used
for the | |
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 | |
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": "5fd4371e940df5a34a3888b2",
- "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": "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",
- "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": [
- {
- "id": "5fd4371e940df5a34a3888b2",
- "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": "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
]
}
}
]
}, - "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"
}
], - "firehose": {
- "credential_id": "5fd4371e940df5a34a3888b2",
- "bucket": "string",
- "prefix": "string",
- "enabled": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
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.
OK
Authorization information is missing or invalid.
[- {
- "name": "Salesforce",
- "instance_id": "string",
- "actions": [
- {
- "name": "Add Lead",
- "action_id": "Add Lead",
- "webhook_url": "string"
}
], - "flow_usages": {
- "count": 0,
- "flows": [
- {
- "id": "5fd4371e940df5a34a3888b2",
- "name": "string"
}
]
}
}
]
Returns all the flows associated to an account
OK
Authorization information is missing or invalid.
[- {
- "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": "5fd4371e940df5a34a3888b2",
- "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": "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",
- "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": [
- {
- "id": "5fd4371e940df5a34a3888b2",
- "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": "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": [ ]
}
}
]
}, - "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"
}
], - "firehose": {
- "credential_id": "5fd4371e940df5a34a3888b2",
- "bucket": "string",
- "prefix": "string",
- "enabled": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
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
Create a new flow
Created
{- "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": "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",
- "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": [
- {
- "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",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "pricing": {
- "override": true,
- "prices": [
- {
- "id": { },
- "amount": 0,
- "rule_set": {
- "op": "and",
- "rules": [
- null
]
}
}
]
}, - "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"
}
], - "firehose": {
- "bucket": "string",
- "prefix": "string",
- "enabled": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "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": "5fd4371e940df5a34a3888b2",
- "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": "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",
- "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": [
- {
- "id": "5fd4371e940df5a34a3888b2",
- "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": "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
]
}
}
]
}, - "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"
}
], - "firehose": {
- "credential_id": "5fd4371e940df5a34a3888b2",
- "bucket": "string",
- "prefix": "string",
- "enabled": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "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": "5fd4371e940df5a34a3888b2",
- "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": "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",
- "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": [
- {
- "id": "5fd4371e940df5a34a3888b2",
- "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": "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
]
}
}
]
}, - "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"
}
], - "firehose": {
- "credential_id": "5fd4371e940df5a34a3888b2",
- "bucket": "string",
- "prefix": "string",
- "enabled": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "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": "5fd4371e940df5a34a3888b2",
- "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": "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",
- "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": [
- {
- "id": "5fd4371e940df5a34a3888b2",
- "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": "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
]
}
}
]
}, - "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"
}
], - "firehose": {
- "credential_id": "5fd4371e940df5a34a3888b2",
- "bucket": "string",
- "prefix": "string",
- "enabled": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
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.
OK
{- "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": "5fd4371e940df5a34a3888b2",
- "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": "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",
- "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": [
- {
- "id": "5fd4371e940df5a34a3888b2",
- "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": "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
]
}
}
]
}, - "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"
}
], - "firehose": {
- "credential_id": "5fd4371e940df5a34a3888b2",
- "bucket": "string",
- "prefix": "string",
- "enabled": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
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.
OK
{- "message": "Your flow was deployed and the most recent changes are now live"
}
List fields associated to the Flow
OK
[- {
- "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"
}
]
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.
OK
{- "property1": 0,
- "property2": 0
}