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. Omitted fields are left unchanged; set description to null to clear it.
Parâmetros
audience_id
string
ID of the audience to update (adn_-prefixed).
Corpo da requisição
name
string
New display name for the audience. Omit to keep the current name; the name cannot be cleared, and a whitespace-only value returns a validation error.
description
nullable string
Longer description of who this audience is. Set to null to clear.
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