Skip to main content
POST
Create Audience List

Authorizations

Authorization
string
header
required

Enter your API key: wave_live_<token>

Body

application/json

Payload to create an audience list and start background scraping.

name
string
required

User-friendly name for this audience list

Required string length: 1 - 150
Example:

"SaaS Founders & Agency Owners"

type
enum<string>
required

Source type of audience: FOLLOWERS, MANUAL

Available options:
FOLLOWERS,
MANUAL
Example:

"FOLLOWERS"

desc
string | null

Optional description or notes for the audience list

Example:

"Scraped followers of @gohighlevel and @hubspot"

max_scrape_count
integer | null
default:500

Maximum number of leads to extract

Required range: x >= 1
Example:

500

parentUsernames
string[] | null

Target Instagram usernames to extract followers from (required if type is FOLLOWERS)

Example:

Target post links if extracting from posts

data
Data · object[] | null

Pre-existing leads data (required if type is MANUAL)

filters
FilterConfigSchema · object[] | null

List of filter criteria to apply to the scraped audience

Response

Successful Response

Full detail of an audience list including filter configurations.

id
string<uuid>
required

Audience list ID

name
string
required
type
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
desc
string | null
max_scrape_count
integer | null
parentUsernames
string[] | null
filters
FilterDetailSchema · object[]

Configured filter rules