Update an audience
PATCH
/v1/audiences/{audience_id}
curl -X PATCH "https://us1.platform.bird.com/v1/audiences/{audience_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Newsletter subscribers"
}'Updates an audience's name or description.
Parâmetros
audience_id
string
Audience ID.
Corpo da requisição
name
string
Display name for the audience.
description
nullable string
Longer description of who this audience is. Set to null to clear.
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