Lead Scrapers

Submit lead scraper inputs

Submits lead scraper inputs for the authenticated client. Validates them and returns the accepted params.

Behavior

  • Does not store a job
  • Does not charge and does not start a scrape
  • To price or pay, use POST /api/v1/lead-scrapers/payment-preview and POST /api/v1/lead-scrapers/payment

Validation

  • scraper_id: must be an id from GET /api/v1/lead-scrapers
  • params: object whose keys are that scraper's inputs. Any other key is rejected
  • Required inputs must be present. Omitted optional inputs are left out of the response
  • Blank select values are left out. Defaults from the form are not filled in
  • number_of_companies on clutch, when present, rounds up to the next 1,000
  • file_name keeps letters, numbers, spaces, underscores, and hyphens
  • string_list and multi_select values are JSON arrays of strings

Response

  • Returns scraper_id and the accepted params
post/api/v1/lead-scrapers/submissions

Request

  • Base URL: https://api.aerosend.io
  • URL: https://api.aerosend.io/api/v1/lead-scrapers/submissions
  • Auth: API key in header X-API-Key

Request body

scraperIdstring

Scraper id from GET /api/v1/lead-scrapers

Example request

{
  "scraperId": "clutch"
}

Response

Inputs accepted

successboolean

Success flag

timestampstring

Response timestamp

Example response

{
  "success": true,
  "data": {
    "scraperId": "clutch"
  },
  "timestamp": "2025-12-14T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.