Skip to main content
POST
Route lead through processor
The processor’s rules choose the task; there is no workflow_id in the request. If a rule routes the lead to an active task, contact starts right away per its cadence; calls wait for the task’s contact hours, and messages go right away unless the task restricts messages to its hours. Leads marked do-not-contact are not contacted, and tasks that only reply (inbound-only) don’t start outreach. If the task is paused, contact starts when it is turned on.
The metadata object is the primary source for routing conditions. Include all the fields your processor’s rules need to evaluate (e.g., language, budget, city, campaign_name).

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_. To work inside a sub-account with a main account key, also send the optional X-Nexor-Sub-Account-Id header.

Path Parameters

processorId
string<uuid>
required

Processor ID

Body

application/json
first_name
string
required
last_name
string | null
email
string<email> | null
phone
string | null
source
string
default:api
company
string | null
title
string | null
metadata
object
campaign_id
string<uuid> | null

Response

Lead or bulk request created and routed.

success
enum<boolean>
required
Available options:
true
lead
any
required

Documented top-level response field.

routing
any
required

Documented top-level response field.

workflow_run
any

Documented top-level response field.

warning
any

Documented top-level response field.

Last modified on October 6, 2026