Create an audience
POST
/v1/audiences
const audience = await bird.audiences.create({ name: "Newsletter subscribers" });
console.log(audience.id); // "adn_…"audience = client.audiences.create(name="Newsletter subscribers")
print(audience.id, audience.name)audience, err := client.Audiences.Create(context.Background(), bird.AudienceCreateParams{
Name: "Newsletter subscribers",
})
if err != nil {
log.Fatal(err)
}
fmt.Println(audience.Id)$audience = $bird->audiences->create(
(new AudienceCreateRequest())->setName('Newsletter subscribers'),
);
echo $audience->getId(); // "adn_…"bird audiences create 'Newsletter subscribers' \
--description 'Contacts who opted into the monthly product newsletter'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.
Corps de la requête
name
string
obligatoire
Display name for the audience.
description
string
Longer description of who this audience is.
type
string
How the audience's recipients are determined. static is an explicit member list you manage by adding and removing contacts.
Possible values: static
Contenu de la réponse
id
string
obligatoire
ID of the audience (adn_-prefixed), accepted by every operation that takes an audience_id.
name
string
obligatoire
Display name for the audience.
description
nullable string
Longer description of who this audience is.
type
string
obligatoire
How the audience's recipients are determined. static is an explicit member list you manage by adding and removing contacts.
Possible values: static
created_at
string
obligatoire
updated_at
string
obligatoire