Flow

{
  "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": "leadconduit-salesforce.outbound.create_contact",
        "mappings": [
          {
            "property": "<string>",
            "value": "<string>",
            "id": "1aacd0"
          }
        ]
      },
      "entity": {
        "id": "5fd4371e940df5a34a3888b2",
        "name": "<string>",
        "time_zone": "America/New_York"
      },
      "id": "1aacd0",
      "caps": [
        {
          "id": "5fd438f91f0d12766e2bfee5",
          "type": "volume",
          "name": "Monthly leads from TX",
          "maximum": 1200,
          "duration": 1,
          "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>"
          }
        ]
      },
      "enabled": true,
      "authentication_required": true,
      "metadata": {}
    }
  ],
  "steps": [
    {
      "type": "calculated",
      "fields": [
        {
          "name": "<string>",
          "rules": [
            {
              "value": "<string>",
              "rule_set": {
                "rules": [
                  {
                    "lhv": "lead.state",
                    "op": "is equal to",
                    "rhv": "TX",
                    "id": "1aacd0",
                    "rule_set": "<unknown>",
                    "metadata": {}
                  }
                ],
                "id": "0d144a"
              },
              "id": "1aacd0"
            }
          ],
          "fallback": "<string>",
          "id": "1aacd0"
        }
      ],
      "id": "1aacd0",
      "description": "<string>",
      "notes": "<string>",
      "enabled": true,
      "metadata": {}
    }
  ],
  "id": "5fd4371e940df5a34a3888b2",
  "errors": {},
  "caps": [
    {
      "id": "5fd438f91f0d12766e2bfee5",
      "type": "volume",
      "name": "Monthly leads from TX",
      "maximum": 1200,
      "duration": 1,
      "caps": "<array>",
      "time_zone": "America/New_York",
      "reason": "<string>",
      "created_at": "2020-11-23T11:41:52Z"
    }
  ],
  "pricing": {
    "override": true,
    "prices": [
      {
        "amount": 123,
        "id": "<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": [
          {
            "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"
    }
  ],
  "metadata": {},
  "level": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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.

The required alphanumeric identifier of the field. Custom fields have an account-specific suffix (e.g. '_acme')

Pattern: ^[a-z0-9][a-z0-9._]*$

Example:

[
  "first_name",
  "last_name",
  "email",
  "phone_1",
  "address_1",
  "city",
  "state",
  "postal_code",
  "trustedform_cert_url"
]

sources

object[]

required

Flows accommodate multiple lead sources. Each source has:

Entity reference - Identifies the submitting party
Inbound mappings - Field name transformations specific to that source
Authentication settings - Credentials and security requirements
Acceptance Criteria - Source-specific rules that must pass in order to continue processing a lead
Pricing configuration - Source-specific cost calculations
Caps - Source-specific caps

Show child attributes

steps

(Calculated Step · object | Filter Step · object | Recipient Step · object | Distribution Step · object | Parallel Step · object)[]

required

After executing acceptance criteria, caps, and pricing, for the source and flow, steps are processed in order sequentially.

A calculated step evaluates rules and templates to set calculated field values on a lead before continuing to the next step.

Calculated Step
Filter Step
Recipient Step
Distribution Step
Parallel Step

Show child attributes

string

The unique identifier for a flow

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

Example:

"5fd4371e940df5a34a3888b2"

errors

object

read-only

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

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

destinations

object[]

Show child attributes

ping_enabled

boolean

default:false

ping_limits

Ping Limit · object[]

Show child attributes

pricing_service

Pricing Service Config · object

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

Show child attributes

firehose

object

Firehose configuration for exporting event data to cloud storage. Supports a legacy flat format (AWS S3 only) and a service-based format that allows multiple cloud storage providers.

Show child attributes

metadata

FlowMetadata · object | null

Not available yet. Metadata on a flow, with the same keys and limits as Metadata. managed_by records what manages the flow; absent means the account does.

Show child attributes

level

string

read-only

The level of the flow, e.g. 'minimal' for buyer accounts

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

API Documentation

Concepts