Terminally stops the lead's sequence (status becomes stopped) so the
executor never contacts it again. The lead stays in the campaign with
its history intact; use DELETE /campaigns/{id}/leads/{leadId} to remove
it entirely. Not resumable. No-op on a lead that is already done, failed
or replied.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Path Parameters
The lead's id.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/campaigns/string/leads/string/stop"{ "data": { "campaignId": "string", "leadId": "string", "linkedinAccountId": "string", "status": "pending", "firstName": "string", "lastName": "string", "headline": "string", "company": "string", "picture": "string", "profileUrl": "string", "publicIdentifier": "string", "openProfile": true, "customVariables": { "property1": "string", "property2": "string" }, "interest": "interested", "interestBy": "manual", "currentStepId": "string", "waitUntil": "2019-08-24T14:15:22Z", "invitationSentAt": "2019-08-24T14:15:22Z", "invitationAccepted": true, "invitationAcceptedAt": "2019-08-24T14:15:22Z", "invitationWithdrawnAt": "2019-08-24T14:15:22Z", "messageSentAt": "2019-08-24T14:15:22Z", "lastReplyAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "error": "string", "createdAt": "2019-08-24T14:15:22Z" }}Set a lead's interest in a campaign PATCH
Only `interest` is editable here. Update lead fields and `customVariables` via `PATCH /leads/{id}` — they're shared across every campaign the lead is in.
Add leads to a list POST
Upserts the workspace leads from the `{ profileUrl, ... }` objects you pass and attaches them to this list in one call — you don't need to create leads separately first. Existing leads are matched on their LinkedIn identifier and updated with any new fields. Max 1000 leads per request.