Routers

Router

A router is a single lead-submission endpoint that's able to distribute lead submissions to any one of an account's various Flows, based on evaluation of rules.

The first rules that match are used to select the Flow and Source; subsequent rules are ignored.

Only one Router for a given integration (module-id) should exist in an account.

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

24 character alpha-numeric BSON identifier

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

24 character alpha-numeric BSON identifier

Array of objects (Route)

The routes to be evaluated by this router

created_at
string <date-time>
updated_at
string <date-time>
{
  • "id": "string",
  • "module_id": "string",
  • "routes": [
    • {
      • "id": "1aacd0",
      • "flow_id": "string",
      • "source_id": "string",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        }
      }
    ],
  • "created_at": "string",
  • "updated_at": "string"
}

List all routers

Get the list of all routers.

SecurityAPIKey
Responses
200

OK

get/routers
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "module_id": "string",
    • "routes": [
      • {
        • "id": "1aacd0",
        • "flow_id": "string",
        • "source_id": "string",
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ],
    • "created_at": "string",
    • "updated_at": "string"
    }
]
Create a router
Create a new custom router, adding it to the list of all routers in the
account.


SecurityAPIKey 
Request 
Request Body schema: application/json
required
Create a new Router


Array of objects (Route) 
The routes to be evaluated by this router


 
Responses 
201
Created


post/routers
Request samples 
application/json
{
  • "routes": [
    • {
      • "rule_set": {
        • "op": "and",
        • "rules": [
          • {
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        }
      }
    ]
}
Response samples 
application/json
[
  • {
    • "id": "string",
    • "module_id": "string",
    • "routes": [
      • {
        • "id": "1aacd0",
        • "flow_id": "string",
        • "source_id": "string",
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ],
    • "created_at": "string",
    • "updated_at": "string"
    }
]
Get a router
Fetch a single router.


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
The ID of the router


 
Responses 
200
OK


get/routers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "module_id": "string",
  • "routes": [
    • {
      • "id": "1aacd0",
      • "flow_id": "string",
      • "source_id": "string",
      • "rule_set": {
        • "id": "1aacd0",
        • "op": "and",
        • "rules": [
          • {
            • "id": "1aacd0",
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        }
      }
    ],
  • "created_at": "string",
  • "updated_at": "string"
}
Update a router
Update an existing custom router. Standard routers cannot be updated.


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
The ID of the router


 
Request Body schema: application/json
required
Update an existing Router


Array of objects (Route) 
The routes to be evaluated by this router


 
Responses 
200
OK


put/routers/{id}
Request samples 
application/json
{
  • "routes": [
    • {
      • "rule_set": {
        • "op": "and",
        • "rules": [
          • {
            • "lhv": "lead.state",
            • "op": "is equal to",
            • "rhv": "TX",
            • "rule_set": { }
            }
          ]
        }
      }
    ]
}
Response samples 
application/json
[
  • {
    • "id": "string",
    • "module_id": "string",
    • "routes": [
      • {
        • "id": "1aacd0",
        • "flow_id": "string",
        • "source_id": "string",
        • "rule_set": {
          • "id": "1aacd0",
          • "op": "and",
          • "rules": [
            • {
              • "id": "1aacd0",
              • "lhv": "lead.state",
              • "op": "is equal to",
              • "rhv": "TX",
              • "rule_set": { }
              }
            ]
          }
        }
      ],
    • "created_at": "string",
    • "updated_at": "string"
    }
]