Create an audience
POST
/v1/audiences
curl -X POST "https://us1.platform.bird.com/v1/audiences" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Newsletter subscribers",
"description": "Contacts who opted into the monthly product newsletter"
}'Creates an audience in the workspace. Static audiences start empty — add contacts via the audience contacts endpoint or the bulk contact upsert.
Corpo da requisição
name
string
obrigatório
Display name for the audience.
description
string
Longer description of who this audience is.
type
string
How the audience's recipients are determined. static audiences have an explicit member list you manage via the API. dynamic and external are preview values and currently unavailable — creating an audience with either returns an error.
Payload de resposta
id
string
obrigatório
Audience ID.
name
string
obrigatório
Display name for the audience.
description
nullable string
Longer description of who this audience is.
type
string
obrigatório
How the audience's recipients are determined. static audiences have an explicit member list you manage via the API. dynamic and external are preview values and currently unavailable — creating an audience with either returns an error.
created_at
string
obrigatório
updated_at
string
obrigatório