Saltar al contenido principal
POST
/
leads
/
{id}
/
assign-workflow
curl --request POST \
  --url https://api.getnexor.ai/api/public/leads/{id}/assign-workflow \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "workflowId": "123e4567-e89b-12d3-a456-426614174000"
}
'
{
  "workflowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "workflowId": "123e4567-e89b-12d3-a456-426614174000",
  "workflowName": "Premium Outreach",
  "movementType": "enrollment",
  "paused": false
}

Autorizaciones

X-API-Key
string
header
requerido

API key for authentication. Keys are prefixed with nxr_live_.

Parámetros de ruta

id
string<uuid>
requerido

Lead ID

Cuerpo

application/json
workflowId
string<uuid>
requerido

ID of the workflow to assign the lead to. Use GET /workflows to list available workflows.

Ejemplo:

"123e4567-e89b-12d3-a456-426614174000"

reason
string

Optional reason for the assignment. Stored on the deactivated workflow run when reassigning.

Ejemplo:

"Lead qualified for premium workflow"

actorId
string

Optional ID of the user or system performing the assignment. Used for audit trail.

Ejemplo:

"user-abc-123"

Respuesta

Workflow assigned successfully

workflowRunId
string<uuid>
requerido

ID of the newly created workflow run

workflowId
string<uuid>
requerido

ID of the assigned workflow

workflowName
string
requerido

Name of the assigned workflow

movementType
enum<string>
requerido

Whether this was a new enrollment (lead had no active workflow) or a reassignment (lead moved from another workflow)

Opciones disponibles:
enrollment,
reassignment
paused
boolean
requerido

Whether the workflow is currently paused. If true, the cadence sequence will not start until the workflow is unpaused.

Última modificación el 18 de junio de 2026