Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.activeprospect.com/llms.txt

Use this file to discover all available pages before exploring further.

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
read-only

ID of this router

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

"5fd4371e940df5a34a3888b2"

module_id
string
read-only

A pointer to the integration code to use for this router

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

"5fd4371e940df5a34a3888b2"

routes
object[]

The routes to be evaluated by this router

created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only