SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
My Leads

Cancel a queued or running research run

Stop a SoftSolz research run. A queued run ends immediately; a running run stops after the company it is on and keeps the leads already saved. Answers 409 run_not_cancellable once the run has finished.

POSThttps://app.softsolz.uk/api/v1/services/my-leads/runs/{id}/cancel

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Response

Response Body

idintegerRun id.
titlestringWhat was researched.
modestringdocument is a written report; leads and businesses produce lead records.
statusstringRun lifecycle.
total_countintegerCompanies found to research.
processed_countintegerCompanies researched so far.
credits_usednumberSoftSolz AI credits the run spent.
cancel_requested_atstring | nullSet once a cancel was requested.
error_messagestring | nullWhy the run failed, if it did.
created_atstringWhen it started.
updated_atstringLast progress update.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/my-leads/runs/{id}/cancel \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"id": 12,
"title": "Bakeries in Manchester",
"mode": "businesses",
"status": "completed",
"total_count": 10,
"processed_count": 10,
"credits_used": 1200,
"cancel_requested_at": null,
"error_message": null,
"created_at": "2026-09-01T09:00:00.000Z",
"updated_at": "2026-09-01T09:10:00.000Z"
}
}