Campaigns

Stop leads in a campaign in bulk

Stops the live enrollments of up to 500 leads in this campaign, the same way DELETE /campaigns/{campaignId}/leads/{leadId} does. A lead with no live enrollment in this campaign (never enrolled, already stopped or finished, or not a lead in this workspace) is skipped as not_live rather than failing the batch, so retrying is safe. Results come back in request order.

POST

/api/v1/campaigns/{campaignId}/leads/bulk-stop

Path parameters

campaignId

required

string · uuid

Campaign id

Request bodyrequired

leadIdsrequired

string · uuid[]

Leads to stop, by id.

Response

200One result per submitted lead id, in request order.

results

object[]

requestId

string · uuid

Id of this request, for support and troubleshooting

Errors

  • 400: Bad request
  • 401: Unauthorized: missing or invalid API key
  • 403: Forbidden
  • 404: Not found
  • 422: Invalid request payload

Search docs

Search documentation, API reference, and MCP tools

We use cookies to enhance your experience on Needle and keep your data secure. Privacy Policy