Skip to main content
POST
Update Lead Status in Bulk
Safety and behavior notes
  • A terminal status can trigger real downstream terminal side effects.
  • When the status has terminal transfer_config, affected leads are withheld unless confirm_transfer_side_effects is exactly true. Opting in can send AI WhatsApp messages and start destination cadence for up to 500 leads.
  • Per-lead work runs with concurrency 10, and partial changes are not rolled back when another lead fails.
  • This forced transition bypasses automatic downgrade and field-stage gates.

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

String UUIDs are processed; malformed/non-string entries are returned in failed[]. Duplicates are silently de-duplicated after total is captured.

status_key
string
required

Only truthy string validation; whitespace-only strings pass the route.

Minimum string length: 1
reason
any

Used only when it is a string; otherwise null. Odoo intake keys override this value and provenance.

confirm_transfer_side_effects
boolean
default:false

Only strict JSON true opts in.

Response

Batch outcome; partial/per-row failures do not change HTTP status.

success
boolean
required
total
integer
required
Required range: 1 <= x <= 500
updated
integer
required
Required range: x >= 0
already_current
integer
required
Required range: x >= 0
blocked_transfer_side_effects
integer
required
Required range: x >= 0
failed
object[]
required
Last modified on September 8, 2026