AI Scout
Describe who to find; a scout reads Google, YouTube and review sites every day and adds the people who fit as leads.
Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| GET | /v3/ai-scouts | List AI Scouts |
| POST | /v3/ai-scouts/plan | Plan an AI Scout |
| POST | /v3/ai-scouts | Create an AI Scout |
| GET | /v3/ai-scouts/{scoutId} | Get an AI Scout |
| PATCH | /v3/ai-scouts/{scoutId} | Update an AI Scout |
| POST | /v3/ai-scouts/{scoutId}/pause | Pause an AI Scout |
| POST | /v3/ai-scouts/{scoutId}/resume | Resume an AI Scout |
| POST | /v3/ai-scouts/{scoutId}/run | Run an AI Scout now |
| DELETE | /v3/ai-scouts/{scoutId} | Delete an AI Scout |
| PUT | /v3/ai-scouts/daily-limit | Set the AI Scout daily limit |
GET
/v3/ai-scoutsParameters
Website IdWebsite ID from list_websites.
curl -X GET "https://rest-admin.happierleads.com/v3/ai-scouts?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9"Response
Press Send request to try it with sample data.
Use case: Plan first, then create
POST /v3/ai-scouts/plan with a description returns the name and sources it would use, free. Send the same description (and the sources you kept) to POST /v3/ai-scouts.
Use case: Keep spend in check
PUT /v3/ai-scouts/daily-limit caps the leads per day across all scouts of the website; perDay caps each scout.
Use case: Pause on Friday, resume on Monday
POST /v3/ai-scouts/{scoutId}/pause and /resume from your scheduler.