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. New audiences start empty: add members with Add contacts to an audience or through Create or update contacts in bulk. Only static audiences can be created today; requesting dynamic or external returns a validation error.
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 (the default) is an explicit member list you manage via the API. dynamic and external are preview values and currently unavailable; creating an audience with either returns a validation error.
Possible values: static, dynamic, external
Payload de resposta
id
string
obrigatório
ID of the audience (adn_-prefixed), accepted by every operation that takes an 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 (the default) is an explicit member list you manage via the API. dynamic and external are preview values and currently unavailable; creating an audience with either returns a validation error.
Possible values: static, dynamic, external
created_at
string
obrigatório
updated_at
string
obrigatório