LocalBusiness

Turn local businesses into leads

Changed on

Starts converting the businesses matching filters into up to count leads, each with a verified email, in one lead list or one campaign. Runs in the background: read its progress with GET /local-business-search/convert/{id}. Costs 2 credits per lead created; businesses without an email cost nothing, and a workspace may scan up to 20000 of them a day (429 local_business_convert_daily_limit). Answers 402 when the balance cannot pay for one lead. A request repeated with the same idempotency_key returns the same conversion. campaign_name also needs the campaigns:create scope.

Requires one of the following scopes: supersearch_enrichments:create, supersearch_enrichments:all, all:create, all:all

post/api/v2/local-business-search/convert

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/local-business-search/convert
  • Auth
    HTTP bearer

Request body

countinteger required
campaign_idstring uuid
campaign_namestring

Creates a draft campaign with this name and the default schedule, and adds the leads to it.

list_idstring uuid
list_namestring
idempotency_keystring required

Example request

{
  "filters": {
    "categories": [
      "dentist"
    ],
    "location": {
      "label": "Austin, TX",
      "country": "US",
      "state": "TX",
      "city": "Austin",
      "lat": 30.2672,
      "long": -97.7431,
      "radius_km": 10
    }
  }
}

Response

Default Response

Changes