Leads in campaigns
Freezes the lead's sequence so the executor stops contacting it
(status becomes paused). It is resumable: step progress and timers are
kept, so resuming continues from where it left off. No-op on a lead that
is already done, failed or replied. Sending the lead a manual message
from the inbox pauses it the same way.
Authorization
bearerAuth AuthorizationBearer <token>
An API key created under Settings → API & Webhooks.
In: header
Path Parameters
id*string
leadId*string
The lead's id.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/campaigns/string/leads/string/pause"{ "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" }}