Skip to main content
POST
Create an audience

Authorizations

Authorization
string
header
required

API key from Developer dashboard (Bearer token).

Body

application/json
platform
enum<string>
required
Available options:
meta,
google
Example:

"meta"

name
string
required
Example:

"Website visitors - 30 days"

subtype
string

Meta: custom/lookalike/website_traffic/engagement. Google: rule_based/crm (maps to list_type).

Example:

"custom"

description
string
Example:

""

retention_days
integer
Example:

30

customer_file_source
string

Meta lookalike/custom audiences only.

Example:

"USER_PROVIDED_ONLY"

origin_audience_id
string

Meta lookalike only - source audience to build the lookalike from.

Example:

""

country
string

Meta lookalike only.

Example:

"US"

ratio
number

Meta lookalike only - similarity ratio.

Example:

0.01

list_type
enum<string>

Google only.

Available options:
rule_based,
crm
Example:

"rule_based"

url_contains
string

Google rule_based lists only.

Example:

"/"

Response

Audience created

success
enum<boolean>
Available options:
true
data
object
meta
object