Skip to main content
POST
Force lead workflow status

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Lead ID

Body

application/json
status_key
string
required

Target workflow status key (e.g. 'qualified', 'lost'). Must exist in the lead's workflow. List valid keys via GET /workflows/{id}.

reason
string

Optional human-readable reason, stored on the run and in the status history.

workflow_id
string<uuid>

Optional. Required only when the lead has multiple active workflow runs.

discard_reason_code
string
discard_reason_label
string
discard_reason_note
string
discard_reason_subcode
string | null
discard_reason_subcode_label
string | null

Response

Status updated (or already in the target status)

success
boolean
changed
boolean

false when the lead was already in the target status (or a concurrent process moved it).

previous_status
string | null
new_status
string
workflow_run
object
note
string

Present only on a concurrent no-op transition.

Last modified on September 10, 2026