Only interest is editable here. Update lead fields and
customVariables via PATCH /leads/{id} — they're shared
across every campaign the lead is in.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Path Parameters
The lead's id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Only interest is editable on a lead's campaign membership. Update
lead fields and customVariables via PATCH /leads/{id}.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/campaigns/string/leads/string" \ -H "Content-Type: application/json" \ -d '{ "interest": "interested" }'{ "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", "history": [ {} ] }}Retry a lead in a campaign POST
Re-queues a `failed` (or stuck) lead for the executor, clearing its error and wait.
Stop a lead in a campaign for good POST
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.