Skip to main content

POST /v1/leads/stop

POST/v1/leads/stop
scope: leads.write 0 credits

Stop one email address everywhere. Only that address, never its colleagues. Use an organization key (a client-scoped key gets 403).

reasonWhat happens
no (default), manualStopped for good. The address goes on your organization blocklist and is never mailed again by SalesLobe (no sequence, reminder or follow-up). Pending follow-ups and auto-replies are cancelled. The lead is stopped in every PlusVibe campaign (status completed), paused in every Smartlead campaign and added to the Smartlead block list, and taken out of the Studio pool and its open batches. SalesLobe never takes it off the blocklist.
bookedThe sequence stops in every campaign and pending follow-ups are cancelled. Not blocklisted: a lead who booked and writes back is still answered. A later cancellation never restarts the sequence.

A permanent stop never becomes temporary. The call is idempotent: send it again to read the result. Instantly has no API to stop one lead, so Instantly campaigns are listed as a step by hand.

A reply that says no (classified not interested) does the same automatically when your organization has it switched on.

Testing​

Send "test": true: nothing changes and the answer lists what would happen. To test for real, use your own test address: send a mail to it from a campaign, reply "no" (or call this endpoint with that address), then check the answer's steps and the lead in the inbox (it shows "Stopped for good").

Try it​

POST/v1/leads/stop
Saved locally in your browser
Request Body
URLhttps://slazbvfvliieskvkjtav.supabase.co/functions/v1/api-gateway/v1/leads/stop

Enter your API key above to send requests