Cap

{
  "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"
}

A cap allows limiting the number of leads sent into or out of a flow. If a lead is successful, it will be counted against the maximum configured leads. If configured, the rule set will be evaluated to determine whether a lead will be counted against the cap.

type

enum<string>

The type of this cap (LeadConduit may eventually support different types of caps)

Available options:

volume

name

string

The human-readable name of the cap

Example:

"Monthly leads from TX"

maximum

number

The number of successful leads that will be accepted

Example:

1200

duration

number

The number duration_units for which the cap persists

Required range: x >= 1

Example:

1

duration_units

enum<string>

The unit of time for which the cap persists

Available options:

month,

week,

day,

hour,

minute

rule_set

Rule Set · object

This rule set must pass in order for the lead to count against the cap

Show child attributes

caps

array

Nested caps evaluated if rules for the parent cap pass

time_zone

string

The time zone in which cap resets

Example:

"America/New_York"

reason

string

When the cap is met this is the reason (default: 'Cap reached')

created_at

string<date-time>

Read-only time the cap was created

Example:

"2020-11-23T11:41:52Z"

Caps and Limits Cap counter

API Documentation

Concepts