Skip to main content
POST
Submit a lead to a router

Path Parameters

router_id
string
required
read-only

The ID of the router 24 character alpha-numeric BSON identifier

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

"5fd4371e940df5a34a3888b2"

Query Parameters

dry_run
boolean

When true, report the matching route and stop without submitting the lead.

Body

The lead data to route, as key-value pairs.

{key}
string

Response

Returned only with dry_run=true. Reports the route that would handle the lead, or that none matched.

message
enum<string>
required
Available options:
Route matched,
No routes matched
module_id
string
required

The router's inbound integration module.

Example:

"leadconduit-default.inbound"

flow_id
string
read-only

24 character alpha-numeric BSON identifier

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

"5fd4371e940df5a34a3888b2"

source_id
string
read-only

24 character alpha-numeric BSON identifier

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

"5fd4371e940df5a34a3888b2"