Skip to main content
DELETE
/
campaigns-leads
/
{id}
Remove a campaign lead
curl --request DELETE \
  --url https://api.dialnexa.com/v1/campaigns-leads/{id} \
  --header 'Authorization: Bearer <token>'
{
  "message": "Lead removed from campaign."
}
Removes a single lead from a campaign queue. If the lead has not been called yet, it is skipped entirely and never dialled. If a call is currently in progress, that call is allowed to complete and its log is preserved. If the lead has already been called, the lead record is removed from the queue but the call log it produced remains queryable through List Call Logs.

​
When to use this

Per-lead removal is the right tool for honoring opt-outs and cleaning up bad data without touching the rest of the campaign. Common cases:
  • Contact requested removal: a customer asked to be removed from outreach. Removing the lead before its turn comes up prevents the call.
  • Data quality fix: the lead was uploaded with an incorrect phone number or wrong consent state. Remove it, correct the source, and re-add the corrected record.
  • Compliance review: the lead needs to be pulled out while you investigate a complaint, but you want to keep the existing call log intact for audit.
To stop the entire campaign rather than a single lead, use Update Campaign to pause it, or cancel it through the dashboard.

​
Behavior

  • Calls already in progress are not interrupted.
  • Call logs produced by previous attempts on this lead remain available.
  • The lead’s queue position is freed; subsequent leads do not shift their scheduled times.

​
Path parameters

ParameterDescription
idThe campaign-lead ID, for example cmp_5tw8vz2rnx1q.

​
Errors

  • 404 Not Found is returned when the campaign-lead does not exist or has already been removed.
  • 409 Conflict is returned when the campaign is in a terminal state (completed or cancelled) and per-lead removal is no longer meaningful.

​
Request

curl -X DELETE "https://api.dialnexa.com/v1/campaigns-leads/cmp_5tw8vz2rnx1q" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

{ "message": "success" }

Authorizations

​
Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header.

Path Parameters

​
id
string
required

Response

Success.

​
message
string
Example:

"Lead removed from campaign."