Stop Campaign

POST/api/v1/jobs/spiderMaps/campaigns/{campaign_id}/stop

Overview

Stop an active campaign. The campaign can be resumed later with the /continue endpoint. Jobs already submitted will continue processing.

Path Parameters

campaign_idstringrequired

The campaign ID to stop

Response

statusstring

New campaign status: stopped

messagestring

Confirmation message

remaining_locationsinteger

Number of locations not yet processed

Example

cURL

curl -X POST https://spideriq.ai/api/v1/jobs/spiderMaps/campaigns/camp_lu_restaurants_abc123/stop \
  -H "Authorization: Bearer <your_token>"

Python

import requests

campaign_id = "camp_lu_restaurants_abc123"
response = requests.post(
    f"https://spideriq.ai/api/v1/jobs/spiderMaps/campaigns/{campaign_id}/stop",
    headers={"Authorization": "Bearer <your_token>"}
)
result = response.json()

print(f"Status: {result['status']}")
print(f"Message: {result['message']}")
print(f"Remaining: {result['remaining_locations']} locations")

Response:

{
  "status": "stopped",
  "message": "Campaign stopped successfully",
  "remaining_locations": 7
}

Notes

• Already-submitted jobs will continue processing
• Use /continue to resume the campaign
• Use /status to check current progress

Related Endpoints

▶️

Continue Campaign

Resume a stopped campaign