Remove Workflow Lead - DialNexa Documentation

Destructive Removes a single lead from a workflow. This is NOT reversible. Use list_workflow_leads first to find the lead_id. Requires confirm: true — only set this after the user has explicitly approved removing this specific lead, never preemptively.

Parameters

Name	Type	Required	Description
`workflow_id`	`string`	Yes	The workflow ID, e.g. workflow_abc123
`lead_id`	`string`	Yes	The lead ID, e.g. lead_abc123
`confirm`	`boolean`	Yes	Must be true. Set this only after the user has explicitly approved removing this specific lead.

Before you call

Connect and initialize the MCP client with OAuth or an API key for the intended workspace.
Provide the required parameters: workflow_id, lead_id, confirm.
Set confirm: true only after the user approves the exact target and action.

Example MCP request

Send tools/call after your client completes MCP initialization. Replace placeholder values with IDs and inputs from your workspace. For object and array parameters, follow the nested requirements in the parameter description instead of treating an empty value as complete.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "remove_workflow_lead",
    "arguments": {
      "workflow_id": "workflow_abc123",
      "lead_id": "lead_abc123",
      "confirm": true
    }
  }
}

The server returns one text content block. Parse content[0].text as JSON when the tool succeeds. See MCP responses and errors for the full envelope and failure behavior.

Verify the result

Confirm the response is not marked isError. Call List Workflow Leads to read the affected resource. Verify that the target is removed or disconnected before reporting completion.

Retry safety

This tool can remove or disconnect a resource. Confirm the exact target first, and do not retry after an uncertain result until you verify the current state.

List Workflow Leads: list_workflow_leads
List Workflows: list_workflows
Get Workflow: get_workflow