Skip to main content
POST
Turn local businesses into leads

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
filters
object
required

A search needs a category, a query or a name, and a location (a city, a state, a country, or lat/long). Unknown fields are dropped and values out of range are clamped. A minimum above its maximum (rating, reviews or locations) answers 400 naming both fields.

count
integer
required
Required range: 1 <= x <= 1000000
idempotency_key
string
required
Required string length: 8 - 80
campaign_id
string<uuid>
campaign_name
string

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

Required string length: 1 - 255
list_id
string<uuid>
list_name
string
Required string length: 1 - 255
skip_owned_leads
boolean

Skip businesses that are already a lead in the current workspace. A skipped business is not charged.

Example:

true

Response

Default Response

job
object
required