Skip to main content
POST
/
flows
Create a new flow
curl --request POST \
  --url https://app.leadconduit.com/flows \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Sales Leads",
  "enabled": true,
  "fields": [
    "first_name",
    "last_name",
    "email",
    "phone_1",
    "address_1",
    "city",
    "state",
    "postal_code",
    "trustedform_cert_url"
  ],
  "sources": [
    {
      "integration": {
        "module_id": "<string>",
        "mappings": [
          {
            "property": "<string>",
            "value": "<string>",
            "rule_set": {
              "op": "and",
              "rules": [
                {
                  "lhv": "lead.state",
                  "op": "is equal to",
                  "rhv": "TX",
                  "rule_set": "<unknown>"
                }
              ]
            }
          }
        ]
      },
      "entity": {
        "time_zone": "America/New_York"
      },
      "acceptance_criteria": {
        "rule_set": {
          "op": "and",
          "rules": [
            {
              "lhv": "lead.state",
              "op": "is equal to",
              "rhv": "TX",
              "rule_set": "<unknown>"
            }
          ]
        },
        "outcome": "failure",
        "reason": "Lead must live in TX"
      },
      "feedback": {
        "integration": {
          "module_id": "<string>",
          "mappings": [
            {
              "property": "<string>",
              "value": "<string>",
              "rule_set": {
                "op": "and",
                "rules": [
                  {
                    "lhv": "lead.state",
                    "op": "is equal to",
                    "rhv": "TX",
                    "rule_set": "<unknown>"
                  }
                ]
              }
            }
          ]
        },
        "rule_set": {
          "op": "and",
          "rules": [
            {
              "lhv": "lead.state",
              "op": "is equal to",
              "rhv": "TX",
              "rule_set": "<unknown>"
            }
          ]
        }
      },
      "caps": [
        {
          "type": "volume",
          "name": "Monthly leads from TX",
          "maximum": 1200,
          "duration": 2,
          "duration_units": "month",
          "rule_set": {
            "op": "and",
            "rules": [
              {
                "lhv": "lead.state",
                "op": "is equal to",
                "rhv": "TX",
                "rule_set": "<unknown>"
              }
            ]
          },
          "caps": "<array>",
          "time_zone": "America/New_York",
          "reason": "<string>",
          "created_at": "2020-11-23T11:41:52Z"
        }
      ],
      "ping_limits": [
        {
          "name": "<string>",
          "maximum": 123,
          "duration": 123,
          "duration_units": "<string>",
          "time_zone": "America/New_York"
        }
      ],
      "pricing": {
        "override": true,
        "prices": [
          {
            "amount": 123,
            "id": "<unknown>",
            "rule_set": {
              "op": "and",
              "rules": [
                {
                  "lhv": "lead.state",
                  "op": "is equal to",
                  "rhv": "TX",
                  "rule_set": "<unknown>"
                }
              ]
            }
          }
        ]
      },
      "pricing_service": {
        "fallback_price": 123
      },
      "enabled": true,
      "authentication_required": true
    }
  ],
  "steps": [
    {
      "type": "filter",
      "outcome": "<string>",
      "rule_set": {
        "op": "and",
        "rules": [
          {
            "lhv": "lead.state",
            "op": "is equal to",
            "rhv": "TX",
            "rule_set": "<unknown>"
          }
        ]
      },
      "description": "<string>",
      "notes": "<string>",
      "reason": "<string>",
      "enabled": true
    }
  ],
  "caps": [
    {
      "type": "volume",
      "name": "Monthly leads from TX",
      "maximum": 1200,
      "duration": 2,
      "duration_units": "month",
      "rule_set": {
        "op": "and",
        "rules": [
          {
            "lhv": "lead.state",
            "op": "is equal to",
            "rhv": "TX",
            "rule_set": "<unknown>"
          }
        ]
      },
      "caps": "<array>",
      "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": "<unknown>"
        }
      ]
    },
    "outcome": "failure",
    "reason": "Lead must live in TX"
  },
  "pricing": {
    "override": true,
    "prices": [
      {
        "amount": 123,
        "id": "<unknown>",
        "rule_set": {
          "op": "and",
          "rules": [
            {
              "lhv": "lead.state",
              "op": "is equal to",
              "rhv": "TX",
              "rule_set": "<unknown>"
            }
          ]
        }
      }
    ]
  },
  "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
    }
  },
  "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": 123,
        "flows": [
          {
            "name": "<string>"
          }
        ]
      }
    }
  ],
  "ping_enabled": false,
  "ping_limits": [
    {
      "name": "<string>",
      "maximum": 123,
      "duration": 123,
      "duration_units": "<string>",
      "time_zone": "America/New_York"
    }
  ],
  "pricing_service": {
    "fallback_price": 123
  },
  "firehose": {
    "enabled": true,
    "bucket": "<string>",
    "prefix": "<string>",
    "services": {
      "aws": {
        "enabled": true,
        "bucket": "<string>",
        "prefix": "<string>"
      },
      "azure": {
        "enabled": true,
        "bucket": "<string>",
        "prefix": "<string>"
      }
    }
  }
}
'
{
  "name": "Sales Leads",
  "enabled": true,
  "fields": [
    "first_name",
    "last_name",
    "email",
    "phone_1",
    "address_1",
    "city",
    "state",
    "postal_code",
    "trustedform_cert_url"
  ],
  "sources": [
    {
      "integration": {
        "module_id": "<string>",
        "mappings": [
          {
            "property": "<string>",
            "value": "<string>",
            "id": "1aacd0",
            "rule_set": {
              "op": "and",
              "rules": [
                {
                  "lhv": "lead.state",
                  "op": "is equal to",
                  "rhv": "TX",
                  "id": "1aacd0",
                  "rule_set": "<unknown>"
                }
              ],
              "id": "0d144a"
            }
          }
        ]
      },
      "entity": {
        "id": "5fd4371e940df5a34a3888b2",
        "name": "<string>",
        "time_zone": "America/New_York"
      },
      "id": "1aacd0",
      "acceptance_criteria": {
        "rule_set": {
          "op": "and",
          "rules": [
            {
              "lhv": "lead.state",
              "op": "is equal to",
              "rhv": "TX",
              "id": "1aacd0",
              "rule_set": "<unknown>"
            }
          ],
          "id": "0d144a"
        },
        "outcome": "failure",
        "reason": "Lead must live in TX"
      },
      "feedback": {
        "integration": {
          "module_id": "<string>",
          "mappings": [
            {
              "property": "<string>",
              "value": "<string>",
              "id": "1aacd0",
              "rule_set": {
                "op": "and",
                "rules": [
                  {
                    "lhv": "lead.state",
                    "op": "is equal to",
                    "rhv": "TX",
                    "id": "1aacd0",
                    "rule_set": "<unknown>"
                  }
                ],
                "id": "0d144a"
              }
            }
          ]
        },
        "rule_set": {
          "op": "and",
          "rules": [
            {
              "lhv": "lead.state",
              "op": "is equal to",
              "rhv": "TX",
              "id": "1aacd0",
              "rule_set": "<unknown>"
            }
          ],
          "id": "0d144a"
        }
      },
      "caps": [
        {
          "id": "5fd438f91f0d12766e2bfee5",
          "type": "volume",
          "name": "Monthly leads from TX",
          "maximum": 1200,
          "duration": 2,
          "duration_units": "month",
          "rule_set": {
            "op": "and",
            "rules": [
              {
                "lhv": "lead.state",
                "op": "is equal to",
                "rhv": "TX",
                "id": "1aacd0",
                "rule_set": "<unknown>"
              }
            ],
            "id": "0d144a"
          },
          "caps": "<array>",
          "time_zone": "America/New_York",
          "reason": "<string>",
          "created_at": "2020-11-23T11:41:52Z"
        }
      ],
      "ping_limits": [
        {
          "id": "5fd4371e940df5a34a3888b2",
          "name": "<string>",
          "maximum": 123,
          "duration": 123,
          "duration_units": "<string>",
          "time_zone": "America/New_York",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "credential_id": "5fd4371e940df5a34a3888b2",
      "pricing": {
        "override": true,
        "prices": [
          {
            "amount": 123,
            "id": "<unknown>",
            "rule_set": {
              "op": "and",
              "rules": [
                {
                  "lhv": "lead.state",
                  "op": "is equal to",
                  "rhv": "TX",
                  "id": "1aacd0",
                  "rule_set": "<unknown>"
                }
              ],
              "id": "0d144a"
            }
          }
        ]
      },
      "pricing_service": {
        "service_id": "5fd4371e940df5a34a3888b2",
        "fallback_price": 123
      },
      "enabled": true,
      "authentication_required": true
    }
  ],
  "steps": [
    {
      "type": "filter",
      "outcome": "<string>",
      "rule_set": {
        "op": "and",
        "rules": [
          {
            "lhv": "lead.state",
            "op": "is equal to",
            "rhv": "TX",
            "id": "1aacd0",
            "rule_set": "<unknown>"
          }
        ],
        "id": "0d144a"
      },
      "id": "1aacd0",
      "description": "<string>",
      "notes": "<string>",
      "reason": "<string>",
      "enabled": true
    }
  ],
  "id": "5fd4371e940df5a34a3888b2",
  "errors": {},
  "caps": [
    {
      "id": "5fd438f91f0d12766e2bfee5",
      "type": "volume",
      "name": "Monthly leads from TX",
      "maximum": 1200,
      "duration": 2,
      "duration_units": "month",
      "rule_set": {
        "op": "and",
        "rules": [
          {
            "lhv": "lead.state",
            "op": "is equal to",
            "rhv": "TX",
            "id": "1aacd0",
            "rule_set": "<unknown>"
          }
        ],
        "id": "0d144a"
      },
      "caps": "<array>",
      "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",
          "id": "1aacd0",
          "rule_set": "<unknown>"
        }
      ],
      "id": "0d144a"
    },
    "outcome": "failure",
    "reason": "Lead must live in TX"
  },
  "pricing": {
    "override": true,
    "prices": [
      {
        "amount": 123,
        "id": "<unknown>",
        "rule_set": {
          "op": "and",
          "rules": [
            {
              "lhv": "lead.state",
              "op": "is equal to",
              "rhv": "TX",
              "id": "1aacd0",
              "rule_set": "<unknown>"
            }
          ],
          "id": "0d144a"
        }
      }
    ]
  },
  "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
    }
  },
  "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": 123,
        "flows": [
          {
            "id": "5fd4371e940df5a34a3888b2",
            "name": "<string>"
          }
        ]
      }
    }
  ],
  "ping_enabled": false,
  "ping_limits": [
    {
      "id": "5fd4371e940df5a34a3888b2",
      "name": "<string>",
      "maximum": 123,
      "duration": 123,
      "duration_units": "<string>",
      "time_zone": "America/New_York",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pricing_service": {
    "service_id": "5fd4371e940df5a34a3888b2",
    "fallback_price": 123
  },
  "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": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

LeadConduit uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'

Body

application/json

Create a new flow

​
name
string
required

The name of the flow

Minimum string length: 1
Example:

"Sales Leads"

​
enabled
boolean
required

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

Example:

true

​
fields
string[]
required

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

Example:
[
  "first_name",
  "last_name",
  "email",
  "phone_1",
  "address_1",
  "city",
  "state",
  "postal_code",
  "trustedform_cert_url"
]
​
sources
object[]
required
​
steps
(Filter Step · object | Recipient Step · object)[]
required

A filter step is used to stop processing a lead from advancing to the next flow step. This is conceptually similar to an email inbox filter. If the lead matches the rules then the flow is stopped, which effectively filters out the lead. When a filter step stops the flow, the source receives an immediate response and no further steps are processed.

​
caps
null | object[]

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

Minimum array length: 1
​
acceptance_criteria
Acceptance Criteria · object

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

​
pricing
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.

​
list_checks
object

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

​
destinations
object[]
​
ping_enabled
boolean
default:false
​
ping_limits
Ping Limit · object[]
​
pricing_service
object

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

​
firehose
object

Response

201 - application/json

Created

​
name
string
required

The name of the flow

Minimum string length: 1
Example:

"Sales Leads"

​
enabled
boolean
required

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

Example:

true

​
fields
string[]
required

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

Example:
[
  "first_name",
  "last_name",
  "email",
  "phone_1",
  "address_1",
  "city",
  "state",
  "postal_code",
  "trustedform_cert_url"
]
​
sources
object[]
required
​
steps
(Filter Step · object | Recipient Step · object)[]
required

A filter step is used to stop processing a lead from advancing to the next flow step. This is conceptually similar to an email inbox filter. If the lead matches the rules then the flow is stopped, which effectively filters out the lead. When a filter step stops the flow, the source receives an immediate response and no further steps are processed.

​
id
string

some custom description

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

"5fd4371e940df5a34a3888b2"

​
errors
object

Errors preventing this flow from being saved

​
caps
null | object[]

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

Minimum array length: 1
​
acceptance_criteria
Acceptance Criteria · object

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

​
pricing
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.

​
list_checks
object

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

​
destinations
object[]
​
ping_enabled
boolean
default:false
​
ping_limits
Ping Limit · object[]
​
pricing_service
object

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

​
firehose
object
​
created_at
string<date-time>
​
updated_at
string<date-time>