Skip to main content
POST
Assign Leads to an Agent in Bulk
Safety and behavior notes
  • Each accepted lead has its current run deactivated, receives a new run, and starts cadence, which can trigger real outbound contact.
  • Per-lead failures are returned inside HTTP 200 with success=false; inspect failed for every request.
  • The request body performs real bulk workflow assignments when submitted.
  • Direct REST executes immediately and has no dry_run or confirm field.
  • Review the complete lead set and destination workflow before submitting the operation.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
lead_ids
any[]
required
Required array length: 1 - 500 elements

The route accepts any JSON item structurally. Only UUID strings are processed; every other item is returned in failed[].

workflow_id
string<uuid>
required
workflowId
string<uuid>
reason
string
default:api_assignment

Response

Batch always returns 200 after workflow validation; success=false means one or more per-lead failures.

success
boolean
required
total
integer
required
Required range: 1 <= x <= 500
assigned
integer
required
Required range: x >= 0
workflow_id
string<uuid>
required
failed
object[]
required
Last modified on September 8, 2026