Assign Agent to Lead

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 }

Authorizations

X-API-Key

string

header

required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

string<uuid>

required

Lead ID

Body

application/json

workflowId

string<uuid>

required

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

Example:

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

reason

string

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

Example:

"Lead qualified for premium workflow"

actorId

string

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

Example:

"user-abc-123"

Response

Workflow assigned successfully

workflowRunId

string<uuid>

required

ID of the newly created workflow run

workflowId

string<uuid>

required

ID of the assigned workflow

workflowName

string

required

Name of the assigned workflow

movementType

enum<string>

required

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

Available options:

enrollment,

reassignment

paused

boolean

required

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